com.ibm.bpe.clientmodel.bean

Class EventActivityBean

  • java.lang.Object
    • com.ibm.bpe.clientmodel.bean.EventActivityBean


  • public class EventActivityBean
    extends java.lang.Object

    Accesses the properties of a BPEL event and adds metadata for national language support and converters. A BPEL event handler is a special activity that can receive events (with a message).

    An EventActivityBean object can be instantiated from an ActivityServiceTemplateData object, an EventHandlerTemplateData object, or a QueryResultSet object. If the bean was instantiated from an original object returned by the Business Process Choreographer API, all properties are loaded. If, however, the bean is instantiated from a query, only the following properties are loaded from the query result set:

    • ATID
    • description
    • VTID
    • portTypeName
    • operation
    If the property was not found in the query result set, the property will remain empty. Accessing an empty property requires the bean to load the missing information from the server.

    Use the static method ActivityInstanceBean.getLabel(String, Locale) to retrieve the localized label for a property. Use the static method ActivityInstanceBean.getConverter(String) to retrieve a converter for a property. The return value may be null because converters are optional.

    See Also:
    EventHandlerTemplateData, ActivityServiceTemplateData, QueryResultSet
    • Field Detail

      • ACTIVITY_DESCRIPTION_PROPERTY

        public static java.lang.String ACTIVITY_DESCRIPTION_PROPERTY
        Use the property name to determine labels and converters for the description property.
      • ACTIVITY_PORTTYPENAME_PROPERTY

        public static java.lang.String ACTIVITY_PORTTYPENAME_PROPERTY
        Use the property name to determine labels and converters for the portTypeName property.
      • ACTIVITY_OPERATIONNAME_PROPERTY

        public static java.lang.String ACTIVITY_OPERATIONNAME_PROPERTY
        Use the property name to determine labels and converters for the operation property.
      • PROCESSINSTANCE_ID_PROPERTY

        public static java.lang.String PROCESSINSTANCE_ID_PROPERTY
        Use the property name to determine labels and converters for the PIID property.
      • PROCESSINSTANCE_INPUTMESSAGE_PROPERTY

        public static java.lang.String PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
        Use the property name to determine labels and converters for the inputMessageTypeName property.
      • ACTIVITY_PORTTYPENAMESPACE_PROPERTY

        public static java.lang.String ACTIVITY_PORTTYPENAMESPACE_PROPERTY
        Use the property name to determine labels and converters for the portTypeNameSpace property.
      • PROCESSTEMPLATE_NAME_PROPERTY

        public static java.lang.String PROCESSTEMPLATE_NAME_PROPERTY
        Use the property name to determine labels and converters for the processTemplateName property.
      • PROCESSTEMPLATE_ID_PROPERTY

        public static java.lang.String PROCESSTEMPLATE_ID_PROPERTY
        Use the property name to determine labels and converters for the processTemplateId property.
      • ACTIVITY_EVENTHANDLER_PROPERTY

        public static java.lang.String ACTIVITY_EVENTHANDLER_PROPERTY
        Use the property name to determine labels and converters for the eventHandler property.
    • Constructor Detail

      • EventActivityBean

        public EventActivityBean(ActivityServiceTemplateData ast,
                         BFMConnection bfmConnection,
                         PIID piid)
        Constructs a new EventyActivityBean from an original ActivityServiceTemplateData object.
        Parameters:
        ast - The original data object.
        bfmConnection - The connection to the BusinessFlowManagerService API.
        piid - The PIID of the affected process.
      • EventActivityBean

        public EventActivityBean(EventHandlerTemplateData origin,
                         BFMConnection bfmConnection,
                         PIID piid)
        Constructs a new EventyActivityBean from an EventHandlerTemplateData object.
        Parameters:
        origin - The original data object.
        bfmConnection - The connection to the BusinessFlowManagerService API.
        piid - The PIID of the affected process.
      • EventActivityBean

        public EventActivityBean(QueryResultSet resultSet)
        Constructs a new EventActivityBean from a QueryResultSet.
        Parameters:
        resultSet - The result object of a query.
    • Method Detail

      • getConverter

        public static SimpleConverter getConverter(java.lang.String propertyName)
        Returns the default converter for a given property.
        Parameters:
        propertyName - The name of the property.
        Returns:
        The converter instance if one has been registered with propertyName, null otherwise.
      • getLabel

        public static java.lang.String getLabel(java.lang.String propertyName)
        Returns the resource bundle key for a property.
        Parameters:
        propertyName - The name for the property.
        Returns:
        The resource bundle key for the property.
      • getLabel

        public static java.lang.String getLabel(java.lang.String propertyName,
                                java.util.Locale locale)
        Returns the label for a property from the resource bundle. If no label is found in the resource bundle, the resource bundle key for the property is returned.
        Parameters:
        propertyName - The name of the property.
        locale - The locale.
        Returns:
        The label or resource bundle key for the property.
      • isValid

        public static boolean isValid(java.lang.String propertyName)
        Checks whether the property is valid.
        Parameters:
        propertyName - The name of the property to be checked.
        Returns:
        True if the propertyName is a known property for an object of this class.
      • getATID

        public ATID getATID()
        Returns the ATID.
      • getDescription

        public java.lang.String getDescription()
        Returns the description.
      • getEHTID

        public EHTID getEHTID()
        Returns the EHTID.
      • getID

        public java.lang.String getID()
        Returns the ID.
      • getInputMessageTypeName

        public java.lang.String getInputMessageTypeName()
        Returns the inputMessageTypeName property.
      • getOperation

        public java.lang.String getOperation()
        Returns the operation property.
      • getPIID

        public PIID getPIID()
        Returns the PIID property.
      • getPortTypeName

        public java.lang.String getPortTypeName()
        Returns the portTypeName property.
      • getPortTypeNameSpace

        public java.lang.String getPortTypeNameSpace()
        Returns the portTypeNameSpace property.
      • getProcessTemplateName

        public java.lang.String getProcessTemplateName()
        Returns the processTemplateName property.
      • getProcessTemplateId

        public PTID getProcessTemplateId()
        Returns the processTemplateId property.
      • getVTID

        public VTID getVTID()
        Returns the VTID property.
      • isEventHandler

        public boolean isEventHandler()
        Returns the eventHandler property. Checks whether this event activity is generated from an event handler template data.
        Returns:
        true if this activity represents an event handler
IBM Business Process ManagerTM
Release 8