com.ibm.commerce.ubf.registry

Class BusinessFlowTransition

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable
    Direct Known Subclasses:
    DynamicBusinessFlowTransition


    public class BusinessFlowTransition
    extends BusinessFlowBase
    implements java.io.Serializable

    BusinessFlowTransitions are contained by BusinessFlowStates.

    See Also:
    Serialized Form
    • Constructor Detail

      • BusinessFlowTransition

        public BusinessFlowTransition(java.lang.Long id,
                                      java.lang.Integer priority,
                                      java.lang.Long flowId,
                                      java.lang.Long sourceStateId,
                                      java.lang.Long targetStateId,
                                      java.lang.String eventIdentifier,
                                      java.lang.Integer approval,
                                      java.lang.String actionInterface,
                                      java.lang.String accessControlGuard,
                                      java.lang.String businessLogicGuard,
                                      java.lang.Long spawnFlowTypeId,
                                      java.lang.Integer spawnType,
                                      java.lang.String reponseViewName,
                                      java.lang.Integer languageId,
                                      java.lang.String description,
                                      java.lang.String eventDescription)
        Constructs a new BusinessFlowTransition with the specified values.
        Parameters:
        id - The transition unique id value.
        priority - The transition priority.
        flowId - The transition flow id.
        sourceStateId - The transition souce state id value.
        targetStateId - The transition target state id value.
        flowStateId - The BusinessFlowState unique id value.
        eventIdentifier - The eventIdentifier for the transition.
        approval - The parameter conveying the approval requirement.
        actionInterface - The actionInterface for the transition.
        accessControlGuard - The accessControlGuard name.
        businessLogicGuard - The businessLogicGuard name.
        spawnFlowTypeId - The flow type of the spawned flow.
        spawnType - The type of Spawning.
        responseViewName - The response view name.
        languageId - The Language id.
        description - The Description String.
        eventDescription - The Event Description String.
    • Method Detail

      • getAccessControlGuard

        public java.lang.String getAccessControlGuard()
        Returns:
        The access control guard string.
      • getActionInterface

        public java.lang.String getActionInterface()
        Returns:
        The action interface string.
      • getApproval

        public java.lang.Integer getApproval()
        Returns:
        The approval value.
      • getBusinessFlow

        public BusinessFlow getBusinessFlow()
        Returns:
        The owning BusinessFlow value.
      • getBusinessFlowID

        public java.lang.Long getBusinessFlowID()
        Returns:
        The owning BusinessFlow id value.
      • getBusinessLogicGuard

        public java.lang.String getBusinessLogicGuard()
        Returns:
        The business logic guard string.
      • getDescription

        public java.lang.String getDescription(java.lang.Integer langId)
        Descriptions may be associated with multiple languages. Use the language id to return the appropriate language description. If the BusinessFlowRegistry cache is enabled and the specified language description is not in the cache then this classes uses the associated EJB Access Bean to return the value and adds a request to the BusinessFlowRegistry to load all of the descriptions for the language into the cache.
        Overrides:
        getDescription in class BusinessFlowBase
        Parameters:
        langId - The language integer id value
        Returns:
        The description value for the specified language
      • getEventDescription

        public java.lang.String getEventDescription(java.lang.Integer langId)
        Descriptions may be associated with multiple languages. Use the language id to return the appropriate language description. If the BusinessFlowRegistry cache is enabled and the specified language description is not in the cache then this classes uses the associated EJB Access Bean to return the value and adds a request to the BusinessFlowRegistry to load all of the descriptions for the language into the cache.
        Parameters:
        langId - The language integer id value.
        Returns:
        The event description value for the specified language.
      • getEventIdentifier

        public java.lang.String getEventIdentifier()
        Returns:
        The event identifier string.
      • getResponseViewName

        public java.lang.String getResponseViewName()
        Returns:
        The response view name string.
      • getSourceBusinessFlowState

        public BusinessFlowState getSourceBusinessFlowState()
        Returns:
        The source BusinessFlowState value.
      • getSourceStateID

        public java.lang.Long getSourceStateID()
        Returns:
        The source BusinessFlowState id value.
      • getSpawnFlowTypeID

        public java.lang.Long getSpawnFlowTypeID()
        Returns:
        The spawn flow type id value.
      • getSpawnType

        public java.lang.Integer getSpawnType()
        Returns:
        The spawn type value.
      • getTargetBusinessFlowState

        public BusinessFlowState getTargetBusinessFlowState()
        Returns:
        The target BusinessFlowState value.
      • getTargetStateID

        public java.lang.Long getTargetStateID()
        Returns:
        The target BusinessFlowState id value.
      • toString

        public java.lang.String toString()
        Returns the string representation.
        Overrides:
        toString in class BusinessFlowBase
        Returns:
        The String representation of the Object.