Package org.kuali.rice.kew.api.document

Class OrchestrationConfig

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.kew.api.document.OrchestrationConfig
All Implemented Interfaces:
Serializable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete
public final class OrchestrationConfig extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    static OrchestrationConfig
    create(String actionTakenId, Set<String> nodeNames)
     
    String
    getActionTakenId()
    Returns the id of the ActionTaken against which any action requests that are processed by the orchestration should be associated.
    Set<String>
    getNodeNames()
    Returns the Set of node names to which to orchestrate the document, may be an empty set in which case the document will be orchestrated from it's current position through the termination of it's entire workflow process.

    Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

    afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • create

      public static OrchestrationConfig create(String actionTakenId, Set<String> nodeNames)

    • getActionTakenId

      public String getActionTakenId()
      Returns the id of the ActionTaken against which any action requests that are processed by the orchestration should be associated. This is generally the action that was submitted which triggered the orchestration process. Should never return a null or blank value.
      Returns:
      the id of the action taken to link deactivated requests with during orchestration

    • getNodeNames

      public Set<String> getNodeNames()
      Returns the Set of node names to which to orchestrate the document, may be an empty set in which case the document will be orchestrated from it's current position through the termination of it's entire workflow process.
      Returns:
      the set of node names to which to orchestrate the document, will never be null but may be empty