com.ibm.bpe.clientmodel.bean

Class EventActivityBean

  1. java.lang.Object
  2. extended bycom.ibm.bpe.clientmodel.bean.EventActivityBean

  1. public class EventActivityBean
  2. 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:

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 Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
ACTIVITY_DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the description property.
  1. static
  2. java.lang.String
ACTIVITY_EVENTHANDLER_PROPERTY
Use the property name to determine labels and converters for the eventHandler property.
  1. static
  2. java.lang.String
ACTIVITY_OPERATIONNAME_PROPERTY
Use the property name to determine labels and converters for the operation property.
  1. static
  2. java.lang.String
ACTIVITY_PORTTYPENAME_PROPERTY
Use the property name to determine labels and converters for the portTypeName property.
  1. static
  2. java.lang.String
ACTIVITY_PORTTYPENAMESPACE_PROPERTY
Use the property name to determine labels and converters for the portTypeNameSpace property.
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. java.lang.String
PROCESSINSTANCE_ID_PROPERTY
Use the property name to determine labels and converters for the PIID property.
  1. static
  2. java.lang.String
PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
Use the property name to determine labels and converters for the inputMessageTypeName property.
  1. static
  2. java.lang.String
PROCESSTEMPLATE_ID_PROPERTY
Use the property name to determine labels and converters for the processTemplateId property.
  1. static
  2. java.lang.String
PROCESSTEMPLATE_NAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateName property.

Constructor Summary

Constructor and Description
EventActivityBean(ActivityServiceTemplateData ast,BFMConnection bfmConnection,PIID piid)
Constructs a new EventyActivityBean from an original ActivityServiceTemplateData object.
EventActivityBean(EventHandlerTemplateData origin,BFMConnection bfmConnection)
Constructs a new EventyActivityBean from an EventHandlerTemplateData object.
EventActivityBean(EventHandlerTemplateData origin,BFMConnection bfmConnection,PIID piid)
Constructs a new EventyActivityBean from an EventHandlerTemplateData object.
EventActivityBean(QueryResultSet resultSet)
Constructs a new EventActivityBean from a QueryResultSet.

Method Summary

Modifier and Type Method and Description
  1. ATID
getATID()
Returns the ATID.
  1. static
  2. SimpleConverter
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
  1. java.lang.String
getDescription()
Returns the description.
  1. EHTID
getEHTID()
Returns the EHTID.
  1. java.lang.String
getID()
Returns the ID.
  1. java.lang.String
getInputMessageTypeName()
Returns the inputMessageTypeName property.
  1. MessageWrapper
getInputMessageWrapper()
Retrieves the input message.
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property.
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label for a property from the resource bundle.
  1. java.lang.String
getOperation()
Returns the operation property.
  1. PIID
getPIID()
Returns the PIID property.
  1. java.lang.String
getPortTypeName()
Returns the portTypeName property.
  1. java.lang.String
getPortTypeNameSpace()
Returns the portTypeNameSpace property.
  1. PTID
getProcessTemplateId()
Returns the processTemplateId property.
  1. java.lang.String
getProcessTemplateName()
Returns the processTemplateName property.
  1. VTID
getVTID()
Returns the VTID property.
  1. boolean
isEventHandler()
Returns the eventHandler property.
  1. static
  2. boolean
isValid(java.lang.String propertyName)
Checks whether the property is valid.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
See Also:

ACTIVITY_DESCRIPTION_PROPERTY

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

ACTIVITY_PORTTYPENAME_PROPERTY

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

ACTIVITY_OPERATIONNAME_PROPERTY

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

PROCESSINSTANCE_ID_PROPERTY

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

PROCESSINSTANCE_INPUTMESSAGE_PROPERTY

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

ACTIVITY_PORTTYPENAMESPACE_PROPERTY

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

PROCESSTEMPLATE_NAME_PROPERTY

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

PROCESSTEMPLATE_ID_PROPERTY

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

ACTIVITY_EVENTHANDLER_PROPERTY

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

Constructor Detail

EventActivityBean

  1. public EventActivityBean(ActivityServiceTemplateData ast,
  2. BFMConnection bfmConnection,
  3. 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

  1. public EventActivityBean(EventHandlerTemplateData origin,
  2. BFMConnection bfmConnection,
  3. 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

  1. public EventActivityBean(EventHandlerTemplateData origin,
  2. BFMConnection bfmConnection)
Constructs a new EventyActivityBean from an EventHandlerTemplateData object.
Parameters:
origin - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.

EventActivityBean

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

Method Detail

getConverter

  1. 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

  1. 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

  1. public static java.lang.String getLabel( java.lang.String propertyName,
  2. 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

  1. 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

  1. public ATID getATID()
Returns the ATID.

getDescription

  1. public java.lang.String getDescription( )
Returns the description.

getEHTID

  1. public EHTID getEHTID()
Returns the EHTID.

getID

  1. public java.lang.String getID()
Returns the ID.

getInputMessageTypeName

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

getOperation

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

getPIID

  1. public PIID getPIID()
Returns the PIID property.

getPortTypeName

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

getPortTypeNameSpace

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

getProcessTemplateName

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

getProcessTemplateId

  1. public PTID getProcessTemplateId( )
Returns the processTemplateId property.

getVTID

  1. public VTID getVTID()
Returns the VTID property.

isEventHandler

  1. 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

getInputMessageWrapper

  1. public MessageWrapper getInputMessageWrapper( )
  2. throws ClientException
Retrieves the input message.
Returns:
The wrapped message.
Throws: