wt.eff
Interface EffService

All Known Implementing Classes:

StandardEffService

public interface EffService

This service provides general effectivity functionality, both through its API and through listeners, that operate on EffManagedVersion, Eff, EffContext, EffConfigurationItem, ProductSolution and ProductInstance objects; this functionality can be reused by various implementations of effectivity including the reference implementation in wt.effectivity. EffConfigSpecAssistant and EffGroupAssistant also execute server-side actions for several classes of objects in this package.

The reference implementation of this service interface also manages effectivity data during various business operations via listeners defined in StandardEffService.

• Cookie: None
• Helper: EffHelper has helper methods
• Service implementation: StandardEffService (has listeners)
• ServiceEvent: None
• ServiceException: None

Supported API: true

Extendable: false

Method Summary

Set<EffRecord>	cloneEffRecords(EffRecordable effRecordable) Clones the EffRecords for passed in EffRecordable.
Map<Boolean,List<ChangeRecordIfc>>	filterEffectableChangeRecords(ChangeActivityIfc changeActivity, List<Changeable2> listChangeables) Filters all change records which associate a changeable in the passed in list with the passed in change activity, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not valid in the list keyed by Boolean.FALSE.
Map<Boolean,List<ChangeRecordIfc>>	filterEffectableChangeRecords(ChangeOrderIfc changeNotice) Filters all change records of passed in change notice and places those for which the associated changeable is a valid effectivity target into list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.
Map<Boolean,List<ChangeRecordIfc>>	filterEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities) Filters all change records across list of passed in change activities and returns those for which the associated changeable is a valid effectivity target into the list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.
Map<Boolean,List<wt.change2.ReportedAgainstIfc>>	filterEffectableReportedAgainsts(ChangeIssue changeIssue) Filters all reported against links of passed in change issue and returns those for which the associated changeable is a valid effectivity target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.
Map<Boolean,List<wt.change2.ReportedAgainstIfc>>	filterEffectableReportedAgainsts(ChangeIssue changeIssue, List<Changeable2> listChangeables) Filters all change records which associate a changeable in the passed in list with the passed in change issue, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.
QueryResult	getAllContexts() Return all EffContext objects in the DB.
EffConfigurationItem	getEffConfigurationItem(String name) Returns the EffConfigurationItem that has this name.
List<ChangeRecordIfc>	getEffectableChangeRecords(ChangeActivityIfc changeActivity, List<Changeable2> listChangeables) Returns all change records which associate a changeable in the passed in list with the passed in change activity, and for which the changeable is a valid eff target.
List<ChangeRecordIfc>	getEffectableChangeRecords(ChangeOrderIfc changeNotice) Returns all change records of passed in change notice for which the associated changeable is a valid effectivity target.
List<ChangeRecordIfc>	getEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities) Returns all change records across list of passed in change activities for which the associated changeable is a valid effectivity target.
List<wt.change2.ReportedAgainstIfc>	getEffectableReportedAgainsts(ChangeIssue changeIssue) Returns all reported against links of passed in change issue for which the associated changeable is a valid effectivity target.
List<wt.change2.ReportedAgainstIfc>	getEffectableReportedAgainsts(ChangeIssue changeIssue, List<Changeable2> listChangeables) Returns all change records which associate a changeable in the passed in list with the passed in change issue, and for which the changeable is a valid eff target.
QueryResult	getEffectivity(EffRecordable effRecordable) For a given EffRecordable returns all the effectivities.
QueryResult	getEffs(EffManagedVersion version) For a given EffManagedVersion, return all Effs assigned to it.
Map<EffManagedVersion,Set<Eff>>	getEffs(WTSet setTargets) For a given set of EffManagedVersion objects, return a map keyed by the target and valued by a set of Effs assigned to the target.
QueryResult	getInstances(EffConfigurationItem configItem) Returns all ProductInstances for this EffConfigurationItem.
boolean	hasPendingEffectivities(EffContext effContext) Given an effectivity context, this method returns whether any existing pending effectivities exist which are active against the context.

Method Detail

getEffs

QueryResult getEffs(EffManagedVersion version)
                    throws WTException

For a given EffManagedVersion, return all Effs assigned to it.

Supported API: true

Parameters:

version -

Returns:

QueryResult

Throws:

WTException

getAllContexts

QueryResult getAllContexts()
                           throws WTException

Return all EffContext objects in the DB. The result is filtered by access control.

Supported API: true

Returns:

QueryResult

Throws:

WTException

getEffConfigurationItem

EffConfigurationItem getEffConfigurationItem(String name)
                                             throws WTException

Returns the EffConfigurationItem that has this name. If none exists, returns null.

Supported API: true

Parameters:

name -

Returns:

EffConfigurationItem

Throws:

WTException

getInstances

QueryResult getInstances(EffConfigurationItem configItem)
                         throws WTException

Returns all ProductInstances for this EffConfigurationItem. The instances are subject to access control.

Supported API: true

Parameters:

configItem -

Returns:

QueryResult

Throws:

WTException

getEffectableChangeRecords

List<ChangeRecordIfc> getEffectableChangeRecords(ChangeOrderIfc changeNotice)
                                                 throws WTException

Returns all change records of passed in change notice for which the associated changeable is a valid effectivity target.

Supported API: true

Parameters:

changeNotice - Change notice to return valid effectivity targetable change records of

Returns:

List

Throws:

WTException

getEffectableChangeRecords

List<ChangeRecordIfc> getEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities)
                                                 throws WTException

Returns all change records across list of passed in change activities for which the associated changeable is a valid effectivity target.

Supported API: true

Parameters:

listChangeActivities - List of change activities

Returns:

List

Throws:

WTException

getEffectableChangeRecords

List<ChangeRecordIfc> getEffectableChangeRecords(ChangeActivityIfc changeActivity,
                                                 List<Changeable2> listChangeables)
                                                 throws WTException

Returns all change records which associate a changeable in the passed in list with the passed in change activity, and for which the changeable is a valid eff target.

Supported API: true

Parameters:

changeActivity - Change activity

listChangeables - List of changeables participating in change record associations with the passed in change activity

Returns:

List

Throws:

WTException

getEffectableReportedAgainsts

List<wt.change2.ReportedAgainstIfc> getEffectableReportedAgainsts(ChangeIssue changeIssue)
                                                                  throws WTException

Returns all reported against links of passed in change issue for which the associated changeable is a valid effectivity target.

Supported API: true

Parameters:

changeIssue - Change issue to return valid effectivity targetable reported againsts of

Returns:

List

Throws:

WTException

getEffectableReportedAgainsts

List<wt.change2.ReportedAgainstIfc> getEffectableReportedAgainsts(ChangeIssue changeIssue,
                                                                  List<Changeable2> listChangeables)
                                                                  throws WTException

Returns all change records which associate a changeable in the passed in list with the passed in change issue, and for which the changeable is a valid eff target.

Supported API: true

Parameters:

changeIssue - Change issue

listChangeables - List of changeables participating in reported against associations with the passed in change issue

Returns:

List

Throws:

WTException

filterEffectableChangeRecords

Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(ChangeOrderIfc changeNotice)
                                                                 throws WTException

Filters all change records of passed in change notice and places those for which the associated changeable is a valid effectivity target into list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.

Supported API: true

Parameters:

changeNotice - Change notice to return valid effectivity targetable change records of

Returns:

Map>

Throws:

WTException

cloneEffRecords

Set<EffRecord> cloneEffRecords(EffRecordable effRecordable)
                               throws WTException

Clones the EffRecords for passed in EffRecordable.

Supported API: true

Parameters:

effRecordable -

Returns:

Set

Throws:

WTException

getEffectivity

QueryResult getEffectivity(EffRecordable effRecordable)
                           throws WTException

For a given EffRecordable returns all the effectivities.

Supported API: true

Parameters:

effRecordable -

Returns:

QueryResult

Throws:

WTException

filterEffectableChangeRecords

Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities)
                                                                 throws WTException

Filters all change records across list of passed in change activities and returns those for which the associated changeable is a valid effectivity target into the list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.

Supported API: true

Parameters:

listChangeActivities - List of change activities

Returns:

Map>

Throws:

WTException

filterEffectableChangeRecords

Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(ChangeActivityIfc changeActivity,
                                                                 List<Changeable2> listChangeables)
                                                                 throws WTException

Filters all change records which associate a changeable in the passed in list with the passed in change activity, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not valid in the list keyed by Boolean.FALSE.

Supported API: true

Parameters:

changeActivity - Change activity

listChangeables - List of changeables participating in change record associations with the passed in change activity

Returns:

Map>

Throws:

WTException

filterEffectableReportedAgainsts

Map<Boolean,List<wt.change2.ReportedAgainstIfc>> filterEffectableReportedAgainsts(ChangeIssue changeIssue)
                                                                                  throws WTException

Filters all reported against links of passed in change issue and returns those for which the associated changeable is a valid effectivity target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.

Supported API: true

Parameters:

changeIssue - Change issue to return valid effectivity targetable reported againsts of

Returns:

Map>

Throws:

WTException

filterEffectableReportedAgainsts

Map<Boolean,List<wt.change2.ReportedAgainstIfc>> filterEffectableReportedAgainsts(ChangeIssue changeIssue,
                                                                                  List<Changeable2> listChangeables)
                                                                                  throws WTException

Filters all change records which associate a changeable in the passed in list with the passed in change issue, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.

Supported API: true

Parameters:

changeIssue - Change issue

listChangeables - List of changeables participating in reported against associations with the passed in change issue

Returns:

Map>

Throws:

WTException

hasPendingEffectivities

boolean hasPendingEffectivities(EffContext effContext)
                                throws WTException

Given an effectivity context, this method returns whether any existing pending effectivities exist which are active against the context.

Supported API: true

Parameters:

effContext - effectivity context

Returns:

boolean

Throws:

WTException

getEffs

Map<EffManagedVersion,Set<Eff>> getEffs(WTSet setTargets)
                                        throws WTException

For a given set of EffManagedVersion objects, return a map keyed by the target and valued by a set of Effs assigned to the target.

Supported API: true

Parameters:

setTargets -

Returns:

Map>

Throws:

WTException