com.ibm.commerce.ubf.registry

Class BusinessFlowType

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

    public class BusinessFlowType
extends BusinessFlowBase
implements java.io.Serializable

    BusinessFlowTypes are contained by BusinessFlowDomains. BusinessFlowTypes contain BusinessFlows, BusinesFlowStates, and BusinessFlowStateGroups.

    See Also:
    Serialized Form

    • Constructor Detail

      • BusinessFlowType

        public BusinessFlowType(java.lang.Long id,
                        java.lang.String businessFlowBeanClass,
                        java.lang.Integer priority,
                        java.lang.String attribute,
                        java.lang.String viewName,
                        java.lang.Long flowDomainId,
                        java.lang.String identifier,
                        java.lang.Integer languageId,
                        java.lang.String shortDescription,
                        java.lang.String description)
        Constructs a new BusinessFlowType with the specified values.
        Parameters:
        id - The flow type unique id value.
        businessFlowBeanClass - The Business flow bean implementation for the flow type.
        priority - The priority.
        attribute - The attribute for the flow type.
        viewName - The response view name.
        flowDomainId - The domain id value.
        identifier - The identifier for the type.
        languageId - The Language id.
        shortDescription - The Description String.
        description - The Event Description String.

    • Method Detail

      • getAttribute

        public java.lang.String getAttribute()
        Returns:
        The attribute string value.

      • getBusinessFlowBeanClass

        public java.lang.String getBusinessFlowBeanClass()
        Returns:
        The string BusinessFlowBeanClass name.

      • getBusinessFlowDomain

        public BusinessFlowDomain getBusinessFlowDomain()
        Returns:
        The owning BusinessFlowDomain value.

      • getBusinessFlowDomainId

        public java.lang.Long getBusinessFlowDomainId()
        Returns:
        The owning BusinessFlowDomain long id value.

      • getBusinessFlows

        public BusinessFlow[] getBusinessFlows()
        Returns:
        An array of BusinessFlows contained by this BusinessFlowType, null if no BusinessFlows are contained by this BusinessFlowType.

      • getBusinessFlowStateGroups

        public BusinessFlowStateGroup[] getBusinessFlowStateGroups()
        Returns:
        An array of BusinessFlowStateGroups contained by this BusinessFlowType, null if no BusinessFlowStateGroups exist for this BusinessFlowType.

      • getBusinessFlowStates

        public BusinessFlowState[] getBusinessFlowStates()
        Returns:
        An array of BusinessFlowStates contained by this BusinessFlowType, null if no BusinessFlowStates are contained by this BusinessFlowType.

      • 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

      • getShortDescription

        public java.lang.String getShortDescription(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 short description value for the specified language.

      • getViewName

        public java.lang.String getViewName()
        Returns:
        The string view name.

      • toString

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