wt.eff
Class StandardEffService

java.lang.Object
  wt.services.StandardManager
      wt.eff.StandardEffService

All Implemented Interfaces:

Serializable, EffService, NetFactor, wt.services.Manager

public class StandardEffService
extends StandardManager
implements EffService, Serializable

This standard implementation of EffService implements much extra functionality via listeners defined in performStartupProcess().

In particular:

• Delete
• Delete the Effs of an EffManagedVersion when it is deleted
• Veto EffContext deletion if its being referenced by existing Effs
• Delete ProductInstances for an EffConfigItem when the configuration item is deleted
• Remove an EffConfigItem's reference to a ProductSolution when the product solution is deleted
• Check Out
• Copy Effs from the original to the working copy
• Check In
• Replace original copy's Effs with the working copy's
• Undo Check Out
• Delete working copy's Effs
• Add/Replace Effs Using EffGroupAssistant
• Veto assignment of Incorporation Date for a ProductInstance that has either not been built or that was built after the assigned incorporation date.

Use the newStandardEffService static factory method(s), not the StandardEffService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

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.

Methods inherited from class wt.services.StandardManager

getManagerService, getManagerStatus, getName, getStartupType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getEffs

public QueryResult getEffs(EffManagedVersion version)
                    throws WTException

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

Supported API: true

Specified by:

getEffs in interface EffService

Parameters:

version -

Returns:

QueryResult

Throws:

WTException

getAllContexts

public QueryResult getAllContexts()
                           throws WTException

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

Supported API: true

Specified by:

getAllContexts in interface EffService

Returns:

QueryResult

Throws:

WTException

getEffConfigurationItem

public EffConfigurationItem getEffConfigurationItem(String name)
                                             throws WTException

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

Supported API: true

Specified by:

getEffConfigurationItem in interface EffService

Parameters:

name -

Returns:

EffConfigurationItem

Throws:

WTException

getInstances

public QueryResult getInstances(EffConfigurationItem configItem)
                         throws WTException

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

Supported API: true

Specified by:

getInstances in interface EffService

Parameters:

configItem -

Returns:

QueryResult

Throws:

WTException

getEffectableChangeRecords

public 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

Specified by:

getEffectableChangeRecords in interface EffService

Parameters:

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

Returns:

List

Throws:

WTException

getEffectableChangeRecords

public 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

Specified by:

getEffectableChangeRecords in interface EffService

Parameters:

listChangeActivities - List of change activities

Returns:

List

Throws:

WTException

getEffectableChangeRecords

public 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

Specified by:

getEffectableChangeRecords in interface EffService

Parameters:

changeActivity - Change activity

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

Returns:

List

Throws:

WTException

getEffectableReportedAgainsts

public 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

Specified by:

getEffectableReportedAgainsts in interface EffService

Parameters:

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

Returns:

List

Throws:

WTException

getEffectableReportedAgainsts

public 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

Specified by:

getEffectableReportedAgainsts in interface EffService

Parameters:

changeIssue - Change issue

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

Returns:

List

Throws:

WTException

filterEffectableChangeRecords

public 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

Specified by:

filterEffectableChangeRecords in interface EffService

Parameters:

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

Returns:

Map>

Throws:

WTException

cloneEffRecords

public Set<EffRecord> cloneEffRecords(EffRecordable effRecordable)
                               throws WTException

Clones the EffRecords for passed in EffRecordable.

Supported API: true

Specified by:

cloneEffRecords in interface EffService

Parameters:

effRecordable -

Returns:

Set

Throws:

WTException

getEffectivity

public QueryResult getEffectivity(EffRecordable effRecordable)
                           throws WTException

For a given EffRecordable returns all the effectivities.

Supported API: true

Specified by:

getEffectivity in interface EffService

Parameters:

effRecordable -

Returns:

QueryResult

Throws:

WTException

filterEffectableChangeRecords

public 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

Specified by:

filterEffectableChangeRecords in interface EffService

Parameters:

listChangeActivities - List of change activities

Returns:

Map>

Throws:

WTException

filterEffectableChangeRecords

public 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

Specified by:

filterEffectableChangeRecords in interface EffService

Parameters:

changeActivity - Change activity

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

Returns:

Map>

Throws:

WTException

filterEffectableReportedAgainsts

public 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

Specified by:

filterEffectableReportedAgainsts in interface EffService

Parameters:

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

Returns:

Map>

Throws:

WTException

filterEffectableReportedAgainsts

public 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

Specified by:

filterEffectableReportedAgainsts in interface EffService

Parameters:

changeIssue - Change issue

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

Returns:

Map>

Throws:

WTException

hasPendingEffectivities

public 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

Specified by:

hasPendingEffectivities in interface EffService

Parameters:

effContext - effectivity context

Returns:

boolean

Throws:

WTException

getEffs

public 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

Specified by:

getEffs in interface EffService

Parameters:

setTargets -

Returns:

Map>

Throws:

WTException