Package wt.maturity

Interface MaturityService

@RemoteInterface public interface MaturityService
The interface describing the services available for the maturity package.

Supported API: true

Extendable: false
See Also:

  • Method Details

    • deletePromotionNotice

      PromotionNotice deletePromotionNotice(PromotionNotice pn) throws WTException, MaturityException
      Deletes a PromotionNotice.

      Supported API: true
      Parameters:
      pn -
      Returns:
      PromotionNotice
      Throws:
      WTException
      MaturityException

    • savePromotionNotice

      PromotionNotice savePromotionNotice(PromotionNotice pn) throws WTException, MaturityException
      Persists the PromotionNotice.

      Supported API: true
      Parameters:
      pn -
      Returns:
      PromotionNotice
      Throws:
      WTException
      MaturityException

    • deletePromotionTargets

      PromotionNotice deletePromotionTargets(PromotionNotice pn, WTSet promotables) throws WTException, MaturityException
      Deletes the PromotionTarget link between the PromotionNotice and the Promotable.

      Supported API: true
      Parameters:
      pn -
      promotables -
      Returns:
      PromotionNotice
      Throws:
      WTException
      MaturityException

    • getPromotionTargets

      QueryResult getPromotionTargets(PromotionNotice pn) throws WTException, MaturityException
      Returns the PromotionTargets associated to the PromotionNotice.

      Supported API: true
      Parameters:
      pn -
      Returns:
      QueryResult
      Throws:
      WTException
      MaturityException

    • savePromotionTargets

      void savePromotionTargets(PromotionNotice pn, WTSet promotables) throws WTException, MaturityException, WTPropertyVetoException
      Creates and persists PromotionTargets between the PromotionNotice and the Promotables.

      Supported API: true
      Parameters:
      pn -
      promotables -
      Throws:
      WTException
      MaturityException
      WTPropertyVetoException

    • savePromotionTargets

      void savePromotionTargets(PromotionNotice pn, WTKeyedHashMap promotables) throws WTException
      Creates and persists PromotionTargets between the PromotionNotice and the Promotables. Takes in a map which is a map of promotables to promotion target attributes

      Supported API: true
      Parameters:
      pn -
      promotables - - Map of promotables to promotion target attributes
      Throws:
      WTException

    • unattachPromotable

      void unattachPromotable(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

    • savePromotionTargets

      WTSet savePromotionTargets(WTSet ptSet) throws WTException, MaturityException, WTPropertyVetoException
      Persists all promotables that are associated to each PromotionTarget contained in the ptSet set. Returns the persisted promotables.

      Supported API: true
      Parameters:
      ptSet -
      Returns:
      WTSet
      Throws:
      WTException
      MaturityException
      WTPropertyVetoException

    • savePromotionSeeds

      void savePromotionSeeds(PromotionNotice pn, WTSet promotables) throws WTException, MaturityException
      Creates and persists PromotionSeeds between the PromotionNotice and the Promotables.

      Supported API: true
      Parameters:
      pn -
      promotables -
      Throws:
      WTException
      MaturityException

    • savePromotionSeeds

      WTSet savePromotionSeeds(WTSet psSet) throws WTException, MaturityException
      Persists PromotionSeeds in the psVector.

      Supported API: true
      Parameters:
      psSet -
      Returns:
      WTSet
      Throws:
      WTException
      MaturityException

    • getPromotionSeeds

      QueryResult getPromotionSeeds(PromotionNotice pn) throws WTException, MaturityException


      Supported API: true
      Parameters:
      pn -
      Returns:
      QueryResult
      Throws:
      WTException
      MaturityException

    • deletePromotionSeeds

      PromotionNotice deletePromotionSeeds(PromotionNotice pn, WTSet promotables) throws WTException, MaturityException
      Deletes the PromotionSeed link between the PromotionNotice and the Promotable.

      Supported API: true
      Parameters:
      pn -
      promotables -
      Returns:
      PromotionNotice
      Throws:
      WTException
      MaturityException

    • getBaselines

      QueryResult getBaselines(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(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(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

    • getPromotionTargets

      QueryResult getPromotionTargets(PromotionNotice pn, boolean onlyOtherSide) throws WTException, MaturityException
      Returns the PromotionTargets associated to the PromotionNotice. If the onlyOtherSide is true, the roleB objects are returned. If the onlyOtherSide is false, the PromotionTarget Links are returned.

      Supported API: true
      Parameters:
      pn -
      onlyOtherSide -
      Returns:
      QueryResult
      Throws:
      WTException
      MaturityException

    • 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

    • generateViewables

      void generateViewables(WTCollection collection, PromotionNotice thePN, ConfigSpec configSpec, boolean defaultRep) throws WTException
      Generates ProductView viewables for the objects in the collection.

      Supported API: true
      Parameters:
      collection - Collection of objects that will have viewables generated.
      thePN - PromotionNotice associated to the collection of objects.
      configSpec - ConfigSpec used by ProductView viewable generation
      defaultRep -
      Throws:
      WTException

    • getTargetPromotionNotices

      WTKeyedHashMap getTargetPromotionNotices(WTCollection pSet) throws WTException
      Returns a WTKeyedHashSet where the keys are the values of pSet and the values are a WTArrayList of PromotionTargets.

      Supported API: true
      Parameters:
      pSet - Set of Promotables
      Returns:
      WTKeyedHashMap
      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

    • startPromotionProcess

      void startPromotionProcess(PromotionNotice notice, WfProcessTemplate template) throws WTException
      This method starts the workflow process defined by template on the PromotionNotice notice.

      Supported API: true
      Parameters:
      notice -
      template -
      Throws:
      WTException