wt.vc.baseline
Interface BaselineService

All Known Implementing Classes:

BaselineServiceFwd, StandardBaselineService

public interface BaselineService

This service interface defines the service API for recording that a Baselineable belongs to a Baseline by persisting a BaselineMember association.

• Cookie: None
• Helper: BaselineHelper has no helper methods
• Service implementation: StandardBaselineService has listeners
• ServiceEvent: BaselineServiceEvent
• ServiceException: WTException

Supported API: true

Extendable: true

See Also:

"'vc package -- Baseline service' in 'Application Developer's Guide'"

Method Summary

Baseline	addToBaseline(Baselineable a_baselineable, Baseline a_baseline) Adds the Baselineable item to the Baseline.
Baseline	addToBaseline(Vector a_baselineables, Baseline a_baseline) Deprecated. Replaced by addToBaseline(WTCollection, Baseline)
Baseline	addToBaseline(WTCollection baselineables, Baseline baseline) Adds the collection of Baselineable items to the Baseline.
QueryResult	getBaselineItems(Baseline a_baseline) Returns a QueryResult of Baselineable item iterations that are part of the Baseline.
QueryResult	getBaselines(Baselineable a_baselineable) Returns a QueryResult of Baseline objects that this Baselineable item iteration is part of.
QueryResult	getBaselines(Baselineable a_baselineable, Class baselineClass) Returns a QueryResult of Baseline objects of a specified class that this Baselineable item iteration is part of.
WTKeyedMap	getBaselines(WTCollection baselineables) Returns a map of baselineables (as keys) to the collection of Baselines they're members of.
WTKeyedMap	getBaselines(WTCollection baselineables, Class baselineClass) Returns a map of baselineables (as keys) to the collection of baselines (of the given class) they're members of.
QueryResult	getManagedBaselines(Baselineable a_baselineable) Returns a QueryResult of ManagedBaseline objects that this Baselineable item iteration is part of.
boolean	isAnyIterationInBaseline(Baselineable a_baselineable, Baseline a_baseline) Returns true, if for this Baselineable, any items with the same Master are part of the Baseline.
boolean	isInBaseline(Baselineable a_baselineable, Baseline a_baseline) Returns true, if the Baselineable item iteration is part of the Baseline.
Baseline	populateBaseline(Persistable a_object, Baseline a_baseline, ConfigSpec a_configSpec) Adds the Baselineable item iterations to the Baseline by navigating recursively from the object using the ConfigSpec.
Baseline	populateBaseline(Persistable a_object, Baseline a_baseline, Navigator a_navigator) Adds the Baselineable item iterations to the Baseline by navigating recursively from the object using the Navigator.
Baseline	removeFromBaseline(Baselineable a_baselineable, Baseline a_baseline) Removes the Baselineable item iteration from the Baseline.
Baseline	removeFromBaseline(Vector a_baselineables, Baseline a_baseline) Deprecated. Replaced by removeFromBaseline(WTCollection, Baseline)
Baseline	removeFromBaseline(WTCollection baselineables, Baseline baseline) Removes the collection of Baselineable item iterations from the Baseline.

Method Detail

getBaselines

public QueryResult getBaselines(Baselineable a_baselineable)
                         throws WTException

Returns a QueryResult of Baseline objects that this Baselineable item iteration is part of. If the iteration is not part of any Baselines, then a QueryResult of size zero is returned.

Note that the Baselineable is considered a member of an IteratedPartialBaseline only if it is a member of its latest iteration(s).

Supported API: true

Parameters:

a_baselineable -

Returns:

QueryResult

Throws:

WTException

getBaselines

public WTKeyedMap getBaselines(WTCollection baselineables)
                        throws WTException

Returns a map of baselineables (as keys) to the collection of Baselines they're members of. If access is enforced, the collections of baselines (that is, the values in the map) will be inflated (to check access) and the represented baselines will be limited to only those the current user has access to. If access is disabled, the values will remain uninflated (however, the baselines in these collections will be connected, so inflating one reference in one collection will inflate the references (to the same baseline) in the other collections). If you've disabled access control but want the baselines inflated, it is recommended you create a new collection, add all the values collections to it, and then inflate the collection (you need not, due to the fact that they're connected, do anything beyond that to get the baselines in the values collections inflated).

Note that the Baselineable is considered a member of an IteratedPartialBaseline only if it is a member of its latest iteration(s).

Supported API: true

Parameters:

baselineables -

Returns:

WTKeyedMap

Throws:

WTException

getBaselines

public QueryResult getBaselines(Baselineable a_baselineable,
                                Class baselineClass)
                         throws WTException

Returns a QueryResult of Baseline objects of a specified class that this Baselineable item iteration is part of. If the iteration is not part of any Baselines of that class, then a QueryResult of size zero is returned.

Note that the Baselineable is considered a member of an IteratedPartialBaseline only if it is a member of its latest iteration(s).

Supported API: true

Parameters:

a_baselineable -

baselineClass -

Returns:

QueryResult

Throws:

WTException

getBaselines

public WTKeyedMap getBaselines(WTCollection baselineables,
                               Class baselineClass)
                        throws WTException

Returns a map of baselineables (as keys) to the collection of baselines (of the given class) they're members of. If access is enforced, the collections of baselines (that is, the values in the map) will be inflated (to check access) and the represented baselines will be limited to only those the current user has access to. If access is disabled, the values will remain uninflated (however, the baselines in these collections will be connected, so inflating one reference in one collection will inflate the references (to the same baseline) in the other collections). If you've disabled access control but want the baselines inflated, it is recommended you create a new collection, add all the values collections to it, and then inflate the collection (you need not, due to the fact that they're connected, do anything beyond that to get the baselines in the values collections inflated).

Note that the Baselineable is considered a member of an IteratedPartialBaseline only if it is a member of its latest iteration(s).

Supported API: true

Parameters:

baselineables -

baselineClass -

Returns:

WTKeyedMap

Throws:

WTException

getManagedBaselines

public QueryResult getManagedBaselines(Baselineable a_baselineable)
                                throws WTException

Returns a QueryResult of ManagedBaseline objects that this Baselineable item iteration is part of. If the iteration is not part of any ManagedBaselines, then a QueryResult of size zero is returned.

Supported API: true

Parameters:

a_baselineable -

Returns:

QueryResult

Throws:

WTException

getBaselineItems

public QueryResult getBaselineItems(Baseline a_baseline)
                             throws WTException

Returns a QueryResult of Baselineable item iterations that are part of the Baseline. If the Baseline contains no items, then a QueryResult of size zero is returned.

Supported API: true

Parameters:

a_baseline -

Returns:

QueryResult

Throws:

WTException

isInBaseline

public boolean isInBaseline(Baselineable a_baselineable,
                            Baseline a_baseline)
                     throws WTException

Returns true, if the Baselineable item iteration is part of the Baseline.

Supported API: true

Parameters:

a_baselineable -

a_baseline -

Returns:

boolean

Throws:

WTException

isAnyIterationInBaseline

public boolean isAnyIterationInBaseline(Baselineable a_baselineable,
                                        Baseline a_baseline)
                                 throws WTException

Returns true, if for this Baselineable, any items with the same Master are part of the Baseline.

Supported API: true

Parameters:

a_baselineable -

a_baseline -

Returns:

boolean

Throws:

WTException

addToBaseline

public Baseline addToBaseline(Baselineable a_baselineable,
                              Baseline a_baseline)
                       throws WTException

Adds the Baselineable item to the Baseline. If another item in the Baseline has the same Master as the Baselineable, then the current item in the Baseline is replaced with this Baselineable. The modification timestamp on the Baseline is updated. If the iteration is currently part of the Baseline, then nothing occurs and no exception is thrown. The PRE_ADD_BASELINE and POST_ADD_BASELINE or PRE_REPLACE_BASELINE and POST_REPLACE_BASELINE events are emitted.

Supported API: true

Parameters:

a_baselineable -

a_baseline -

Returns:

Baseline

Throws:

WTException

addToBaseline

public Baseline addToBaseline(Vector a_baselineables,
                              Baseline a_baseline)
                       throws WTException

Deprecated. Replaced by addToBaseline(WTCollection, Baseline)

Adds the Vector of Baselineable items to the Baseline. When adding an item, if another item in the Baseline has the same Master as that item, then the current item in the Baseline is replaced with that item. All items are added within a single transaction. The modification timestamp on the Baseline is updated once after all items have been added. The PRE_ADD_BASELINE and POST_ADD_BASELINE or PRE_REPLACE_BASELINE and POST_REPLACE_BASELINEevents are emitted for each item.

Supported API: false

Parameters:

a_baselineables -

a_baseline -

Returns:

Baseline

Throws:

WTException

addToBaseline

public Baseline addToBaseline(WTCollection baselineables,
                              Baseline baseline)
                       throws WTException

Adds the collection of Baselineable items to the Baseline. When adding an item, if another item in the Baseline has the same Master as that item, then the current item in the Baseline is replaced with that item. All items are added within a single transaction. The modification timestamp on the Baseline is updated once after all items have been added. The PRE_ADD_BASELINE and POST_ADD_BASELINE or PRE_REPLACE_BASELINE and POST_REPLACE_BASELINEevents are emitted for each item.

Supported API: true

Parameters:

baselineables -

baseline -

Returns:

Baseline

Throws:

WTException

removeFromBaseline

public Baseline removeFromBaseline(Baselineable a_baselineable,
                                   Baseline a_baseline)
                            throws WTException

Removes the Baselineable item iteration from the Baseline. The modification timestamp on the Baseline is updated. If the iteration is not currently part of the Baseline, then nothing occurs and no exception is thrown. The PRE_REMOVE_BASELINE and POST_REMOVE_BASELINE events are emitted.

Supported API: true

Parameters:

a_baselineable -

a_baseline -

Returns:

Baseline

Throws:

WTException

removeFromBaseline

public Baseline removeFromBaseline(Vector a_baselineables,
                                   Baseline a_baseline)
                            throws WTException

Deprecated. Replaced by removeFromBaseline(WTCollection, Baseline)

Removes the Baselineable item iterations from the Baseline. All items are removed within a single transaction. The modification timestamp on the Baseline is updated. The PRE_REMOVE_BASELINE and POST_REMOVE_BASELINE events are emitted for each item.

Supported API: false

Parameters:

a_baselineables -

a_baseline -

Returns:

Baseline

Throws:

WTException

populateBaseline

public Baseline populateBaseline(Persistable a_object,
                                 Baseline a_baseline,
                                 Navigator a_navigator)
                          throws WTException

Adds the Baselineable item iterations to the Baseline by navigating recursively from the object using the Navigator. All items are added within a single transaction. If iterations for the same Master of an item appear more than once in the structure, then the item iteration that was first encountered will be added to the Baseline. The modification timestamp on the Baseline is updated once after all items have been added. The PRE_ADD_BASELINE and POST_ADD_BASELINE or PRE_REPLACE_BASELINE and POST_REPLACE_BASELINEevents are emitted for each item.

Supported API: true

Parameters:

a_object -

a_baseline -

a_navigator -

Returns:

Baseline

Throws:

WTException

populateBaseline

public Baseline populateBaseline(Persistable a_object,
                                 Baseline a_baseline,
                                 ConfigSpec a_configSpec)
                          throws WTException

Adds the Baselineable item iterations to the Baseline by navigating recursively from the object using the ConfigSpec. The object is assumed to be an Part and the navigation is done via the Part "uses" link. All items are added within a single transaction. If iterations for the same Master of an item appear more than once in the structure, then the item iteration that was first encountered will be added to the Baseline. The modification timestamp on the Baseline is updated once after all items have been added. The PRE_ADD_BASELINE and POST_ADD_BASELINE or PRE_REPLACE_BASELINE and POST_REPLACE_BASELINEevents are emitted for each item.

Supported API: true

Parameters:

a_object -

a_baseline -

a_configSpec -

Returns:

Baseline

Throws:

WTException

removeFromBaseline

public Baseline removeFromBaseline(WTCollection baselineables,
                                   Baseline baseline)
                            throws WTException

Removes the collection of Baselineable item iterations from the Baseline. All items are removed within a single transaction. The modification timestamp on the Baseline is updated. The PRE_REMOVE_BASELINE and POST_REMOVE_BASELINE events are emitted for each item.

Supported API: true

Parameters:

baselineables -

baseline -

Returns:

Baseline

Throws:

WTException