wt.maturity
Interface MaturityService

All Known Implementing Classes:

StandardMaturityService

public interface MaturityService

The interface describing the services available for the maturity package.

Supported API: true

Extendable: false

See Also:

MaturityHelper, MaturityService, MaturityServiceFwd

Method Summary

QueryResult	getBaselineItems(PromotionNotice promotionNotice) Returns a QueryResult of MaturityVersioned, Baselineable item iterations that are part of the Maturity Baseline associated to the PromotionNotice.
QueryResult	getBaselines(Baselineable promotable, Class promotionNoticeClass) Returns a QueryResult of MaturityVersioned Baseline objects of a specified class that this Baselineable item iteration is part of.
QueryResult	getBaselines(wt.maturity.Promotable promotable) Returns a QueryResult of MaturityVersioned Baseline objects that this MaturityVersioned Baselineable item iteration is part of.
WTSet	getInvalidTargets(WTCollection promotionTargets, boolean includeLocks) Returns the set of invalid promotion targets of a given promotion notice.
WTCollection	getPromotionNotices(WTCollection promotables) Supported API: true
WTKeyedHashMap	getPromotionNotices(WTSet promotables, State state) This method returns a WTKeyedHashMap containing the passed in Promotable as the key and any PromotionNotices that match the passed in state as the values which are contained in a WTSet.
WTKeyedHashMap	getPromotionNoticesMap(WTCollection promotables) This method returns a WTKeyedHashMap containing the passed in Promotable as the key and any PromotionNotices as the values which are contained in a WTSet.
boolean	isAnyIterationInBaseline(wt.maturity.Promotable promotable, PromotionNotice promotionNotice) Returns true, if for this Maturity Baselineable, any items with the same Master are part of the MaturityBaseline associated to the PromotionNotice.
boolean	isInBaseline(wt.maturity.Promotable promotable, PromotionNotice promotionNotice) Returns true, if the MaturityVersioned item iteration is part of the MaturityBaseline associated to the PromotionNotice.
void	unattachPromotable(wt.maturity.Promotable refObject, PromotionNotice promotionNotice, Class linkClass, String maturityRole) Deletes the association between a PromotionNotice and a Promotable.

Method Detail

unattachPromotable

void unattachPromotable(wt.maturity.Promotable refObject,
                        PromotionNotice promotionNotice,
                        Class linkClass,
                        String maturityRole)
                        throws WTException,
                               MaturityException

Deletes the association between a PromotionNotice and a Promotable.

Supported API: true

Parameters:

refObject - A MaturityVersioned object to be disassociatd from a PromotionNotice

promotionNotice - The PromotionNotice associated to the MaturityVersioned.

linkClass - The associated link Class, which has a PromotionNotice as role A.

maturityRole - The role name.

Throws:

WTException

MaturityException

getBaselines

QueryResult getBaselines(wt.maturity.Promotable promotable)
                         throws WTException

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

Supported API: true

Parameters:

promotable -

Returns:

QueryResult

Throws:

WTException

getBaselines

QueryResult getBaselines(Baselineable promotable,
                         Class promotionNoticeClass)
                         throws WTException

Returns a QueryResult of MaturityVersioned 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.

Supported API: true

Parameters:

promotable -

promotionNoticeClass -

Returns:

QueryResult

Throws:

WTException

getBaselineItems

QueryResult getBaselineItems(PromotionNotice promotionNotice)
                             throws WTException

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

Supported API: true

Parameters:

promotionNotice -

Returns:

QueryResult

Throws:

WTException

isInBaseline

boolean isInBaseline(wt.maturity.Promotable promotable,
                     PromotionNotice promotionNotice)
                     throws WTException

Returns true, if the MaturityVersioned item iteration is part of the MaturityBaseline associated to the PromotionNotice.

Supported API: true

Parameters:

promotable -

promotionNotice -

Returns:

boolean

Throws:

WTException

isAnyIterationInBaseline

boolean isAnyIterationInBaseline(wt.maturity.Promotable promotable,
                                 PromotionNotice promotionNotice)
                                 throws WTException

Returns true, if for this Maturity Baselineable, any items with the same Master are part of the MaturityBaseline associated to the PromotionNotice.

Supported API: true

Parameters:

promotable -

promotionNotice -

Returns:

boolean

Throws:

WTException

getInvalidTargets

WTSet getInvalidTargets(WTCollection promotionTargets,
                        boolean includeLocks)
                        throws WTException

Returns the set of invalid promotion targets of a given promotion notice. A promotion target is invalid if its current state is not the valid locking state, if this is defined, or the initial state from when the promotion notice was created.

Supported API: true

Parameters:

promotionTargets -

includeLocks - If true, validate considering lock states. If false, validate without considering lock states.

Returns:

WTSet

Throws:

WTException

getPromotionNotices

WTCollection getPromotionNotices(WTCollection promotables)
                                 throws WTException

Supported API: true

Parameters:

promotables -

Returns:

WTCollection

Throws:

WTException

getPromotionNotices

WTKeyedHashMap getPromotionNotices(WTSet promotables,
                                   State state)
                                   throws WTException

This method returns a WTKeyedHashMap containing the passed in Promotable as the key and any PromotionNotices that match the passed in state as the values which are contained in a WTSet.

Supported API: true

Parameters:

promotables -

state -

Returns:

WTKeyedHashMap

Throws:

WTException

getPromotionNoticesMap

WTKeyedHashMap getPromotionNoticesMap(WTCollection promotables)
                                      throws WTException

This method returns a WTKeyedHashMap containing the passed in Promotable as the key and any PromotionNotices as the values which are contained in a WTSet.

Supported API: true

Parameters:

promotables -

Returns:

WTKeyedHashMap

Throws:

WTException