com.ibm.commerce.ubf.event

Class BusinessFlowEventData

  • java.lang.Object
    • com.ibm.commerce.ubf.event.BusinessFlowEventData


  • public class BusinessFlowEventData
    extends java.lang.Object
    BusinessFlowEventData is used to contain all information needed for UBF when an event is raised.
    See Also:
    BusinessFlowEventListener, BusinessFlowEvent
    • Constructor Summary

      Constructors 
      Constructor and Description
      BusinessFlowEventData(com.ibm.commerce.command.CommandContext aCommandContext, com.ibm.commerce.datatype.TypedProperty newRequestProperties)
      Construct a BusinessFlowEventData object which contain all information needed for UBF.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void checkRequestProperties()
      Check and set up all required input parameters for a business flow instance.
      com.ibm.commerce.command.CommandContext getCommandContext()
      Get the CommandContext object.
      java.lang.String getComments()
      Get the approval comment.
      java.lang.Long getEntityId()
      Get the Id of the business flow entity.
      BusinessFlowEntityBean getEntityObject()
      Get the business flow entity object.
      java.lang.String getErrorResponseView()
      Insert the method's description here.
      java.lang.String getEventIdentifier()
      Get the event identifier.
      java.lang.Long getFlowId()
      Get the id of the business flow.
      java.lang.String getFlowStages()
      Get the flow stage string.
      java.lang.Long getFlowTypeId()
      Get the id of the business flow type.
      java.lang.String getFlowTypeIdentifier()
      Get the identifier of the business flow type.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Get the requestProperties which has a type of TypedProperty.
      java.lang.String getResourceClassName()
      Insert the method's description here.
      java.lang.Long getResourceId()
      Insert the method's description here.
      com.ibm.commerce.datatype.TypedProperty getResponseProperties()
      Get the responseProperties which has a type of TypedProperty.
      void setCommandContext(com.ibm.commerce.command.CommandContext newCommandContext)
      Set the CommandContext object.
      void setComments(java.lang.String newComments)
      Set the approval comment.
      void setEntityId(java.lang.Long newEntityId)
      Set the Id of the business flow entity.
      void setEntityObject(BusinessFlowEntityBean newEntityObject)
      Set the business flow entity object.
      void setErrorResponseView(java.lang.String newErrorResponseView)
      Insert the method's description here.
      void setEventIdentifier(java.lang.String newEventIdentifier)
      Set the event identifier.
      void setFlowId(java.lang.Long newFlowId)
      Set the id of the business flow.
      void setFlowStages(java.lang.String newFlowStages)
      Set the flow stage string.
      void setFlowTypeId(java.lang.Long newFlowTypeId)
      Set the id of the business flow type.
      void setFlowTypeIdentifier(java.lang.String newFlowTypeIdentifier)
      Set the identifier of the business flow type.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty newRequestProperties)
      Set the requestProperties which has a type of TypedProperty.
      void setResourceClassName(java.lang.String newResourceClassName)
      Insert the method's description here.
      void setResourceId(java.lang.Long newResourceId)
      Insert the method's description here.
      void setResponseProperties(com.ibm.commerce.datatype.TypedProperty newResponseProperties)
      Set the responseProperties which has a type of TypedProperty.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BusinessFlowEventData

        public BusinessFlowEventData(com.ibm.commerce.command.CommandContext aCommandContext,
                                     com.ibm.commerce.datatype.TypedProperty newRequestProperties)
                              throws com.ibm.commerce.exception.ECException
        Construct a BusinessFlowEventData object which contain all information needed for UBF.
        Parameters:
        aCommandContext - The CommandContext object.
        newRequestProperties - The RequestProperties object.
        Throws:
        com.ibm.commerce.exception.ECException
    • Method Detail

      • checkRequestProperties

        public void checkRequestProperties()
                                    throws com.ibm.commerce.exception.ECException
        Check and set up all required input parameters for a business flow instance. If some mandatory parameters are missing, appropriate exceptions will be thrown. If it is a new flow instance, event and flowId (or flowStages) are mandatory. If it is an existing flow instance, event, entityId, flowType are mandatory.
        Throws:
        com.ibm.commerce.exception.ECException - If the required parameters are missing or have invalid values.
      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Get the CommandContext object.
        Returns:
        The CommandContext object.
      • getComments

        public java.lang.String getComments()
        Get the approval comment.
        Returns:
        The approval comment string.
      • getEntityId

        public java.lang.Long getEntityId()
        Get the Id of the business flow entity.
        Returns:
        The Id of the business flow entity.
      • getEntityObject

        public BusinessFlowEntityBean getEntityObject()
        Get the business flow entity object.
        Returns:
        The business flow entity bean.
      • getErrorResponseView

        public java.lang.String getErrorResponseView()
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        Returns:
        The key for doing this lock.
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • getEventIdentifier

        public java.lang.String getEventIdentifier()
        Get the event identifier.
        Returns:
        The event identifier string.
      • getFlowId

        public java.lang.Long getFlowId()
        Get the id of the business flow.
        Returns:
        The business flow id.
      • getFlowStages

        public java.lang.String getFlowStages()
        Get the flow stage string.
        Returns:
        The flow stage string.
      • getFlowTypeId

        public java.lang.Long getFlowTypeId()
        Get the id of the business flow type.
        Returns:
        The business flow type id.
      • getFlowTypeIdentifier

        public java.lang.String getFlowTypeIdentifier()
        Get the identifier of the business flow type.
        Returns:
        The business flow type identifier string.
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Get the requestProperties which has a type of TypedProperty.
        Returns:
        The requestProperties object.
      • getResourceClassName

        public java.lang.String getResourceClassName()
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        Returns:
        The key for doing this lock.
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • getResourceId

        public java.lang.Long getResourceId()
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        Returns:
        The key for doing this lock.
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • getResponseProperties

        public com.ibm.commerce.datatype.TypedProperty getResponseProperties()
        Get the responseProperties which has a type of TypedProperty.
        Returns:
        The responseProperties object.
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext newCommandContext)
        Set the CommandContext object.
        Parameters:
        newCommandContext - The CommandContext object.
      • setComments

        public void setComments(java.lang.String newComments)
        Set the approval comment.
        Parameters:
        newComments - The approval comment.
      • setEntityId

        public void setEntityId(java.lang.Long newEntityId)
        Set the Id of the business flow entity.
        Parameters:
        newEntityId - The Id of the business flow entity.
      • setEntityObject

        public void setEntityObject(BusinessFlowEntityBean newEntityObject)
        Set the business flow entity object.
        Parameters:
        newEntityObject - The business flow entity object.
      • setErrorResponseView

        public void setErrorResponseView(java.lang.String newErrorResponseView)
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        newErrorResponseView - java.lang.String
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • setEventIdentifier

        public void setEventIdentifier(java.lang.String newEventIdentifier)
        Set the event identifier.
        Parameters:
        newEventIdentifier - The event identifier.
      • setFlowId

        public void setFlowId(java.lang.Long newFlowId)
        Set the id of the business flow.
        Parameters:
        newFlowId - The id of the business flow.
      • setFlowStages

        public void setFlowStages(java.lang.String newFlowStages)
        Set the flow stage string.
        Parameters:
        newFlowStages - The flow stage string.
      • setFlowTypeId

        public void setFlowTypeId(java.lang.Long newFlowTypeId)
        Set the id of the business flow type.
        Parameters:
        newFlowTypeId - The id of the business flow type.
      • setFlowTypeIdentifier

        public void setFlowTypeIdentifier(java.lang.String newFlowTypeIdentifier)
        Set the identifier of the business flow type.
        Parameters:
        newFlowTypeIdentifier - The identifier of the business flow type.
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty newRequestProperties)
                                  throws com.ibm.commerce.exception.ECException
        Set the requestProperties which has a type of TypedProperty.
        Parameters:
        newRequestProperties - The requestProperties which has a type of TypedProperty.
        Throws:
        com.ibm.commerce.exception.ECException
      • setResourceClassName

        public void setResourceClassName(java.lang.String newResourceClassName)
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        newResourceClassName - java.lang.String
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • setResourceId

        public void setResourceId(java.lang.Long newResourceId)
        Insert the method's description here.
        Parameters:
        length - The Number of bytes to lock.
        newResourceId - java.lang.Long
        Throws:
        ServerStartException - If the AS/400 server canot be started.
      • setResponseProperties

        public void setResponseProperties(com.ibm.commerce.datatype.TypedProperty newResponseProperties)
        Set the responseProperties which has a type of TypedProperty.
        Parameters:
        newResponseProperties - The responseProperties which has a type of TypedProperty.