com.ibm.bpe.clientmodel.bean
Class EventActivityBean

java.lang.Object
  extended bycom.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 which can receive events (with a message).

An EventActivityBean object can be instantiated from an ActivityServiceTemplateData object, from an EventHandlerTemplateData object or from a QueryResultSet object. If the bean was instantiated from an original object returned by the Business Process Choreographer API, all properties are loaded. If the bean is instantiated from a query only the following properties are going to be 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
static java.lang.String ACTIVITY_DESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the property description.
static java.lang.String ACTIVITY_EVENTHANDLER_PROPERTY
          Use the property name to determine labels and converters for the property eventHandler.
static java.lang.String ACTIVITY_OPERATIONNAME_PROPERTY
          Use the property name to determine labels and converters for the property operation.
static java.lang.String ACTIVITY_PORTTYPENAME_PROPERTY
          Use the property name to determine labels and converters for the property activity portTypeName.
static java.lang.String ACTIVITY_PORTTYPENAMESPACE_PROPERTY
          Use the property name to determine labels and converters for the property portTypeNameSpace.
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
static java.lang.String PROCESSINSTANCE_ID_PROPERTY
          Use the property name to determine labels and converters for the property PIID.
static java.lang.String PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
          Use the property name to determine labels and converters for the property inputMessageTypeName.
static java.lang.String PROCESSTEMPLATE_NAME_PROPERTY
          Use the property name to determine labels and converters for the property processTemplateName.
 
Constructor Summary
EventActivityBean(com.ibm.bpe.api.ActivityServiceTemplateData ast, BFMConnection bfmConnection)
          Constructs a new EventyActivityBean from an original ActivityServiceTemplateData object.
EventActivityBean(com.ibm.bpe.api.EventHandlerTemplateData origin, BFMConnection bfmConnection)
          Constructs a new EventyActivityBean from an EventHandlerTemplateData object.
EventActivityBean(com.ibm.bpe.api.QueryResultSet resultSet)
          Constructs a new EventActivityBean from a QueryResultSet.
 
Method Summary
 com.ibm.bpe.api.ATID getATID()
          Returns the property ATID.
static SimpleConverter getConverter(java.lang.String propertyName)
          Returns the default converter for a given property.
 java.lang.String getDescription()
          Returns the property description.
 com.ibm.bpe.api.EHTID getEHTID()
          Returns the property EHTID.
 java.lang.String getID()
          Returns the property ID.
 java.lang.String getInputMessageTypeName()
          Returns the property inputMessageTypeName.
 MessageWrapper getInputMessageWrapper()
          Retrieves the input message.
static java.lang.String getLabel(java.lang.String propertyName)
          Returns the resource bundle key for a property
static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
          Returns the label for a property from the resource bundle.
 java.lang.String getOperation()
          Returns the property operation.
 com.ibm.bpe.api.PIID getPIID()
          Returns the property PIID.
 java.lang.String getPortTypeName()
          Returns the property portTypeName.
 java.lang.String getPortTypeNameSpace()
          Returns the property portTypeNameSpace.
 java.lang.String getProcessTemplateName()
          Returns the property processTemplateName.
 com.ibm.bpe.api.VTID getVTID()
          Returns the property VTID.
 boolean isEventHandler()
          Returns the property eventHandler.
static boolean isValid(java.lang.String propertyName)
          Checks if the property is valid.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005.

See Also:
Constant Field Values

ACTIVITY_DESCRIPTION_PROPERTY

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


ACTIVITY_PORTTYPENAME_PROPERTY

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


ACTIVITY_OPERATIONNAME_PROPERTY

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


PROCESSINSTANCE_ID_PROPERTY

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


PROCESSINSTANCE_INPUTMESSAGE_PROPERTY

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


ACTIVITY_PORTTYPENAMESPACE_PROPERTY

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


PROCESSTEMPLATE_NAME_PROPERTY

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


ACTIVITY_EVENTHANDLER_PROPERTY

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

Constructor Detail

EventActivityBean

public EventActivityBean(com.ibm.bpe.api.ActivityServiceTemplateData ast,
                         BFMConnection bfmConnection)
Constructs a new EventyActivityBean from an original ActivityServiceTemplateData object.

Parameters:
ast - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.

EventActivityBean

public EventActivityBean(com.ibm.bpe.api.EventHandlerTemplateData origin,
                         BFMConnection bfmConnection)
Constructs a new EventyActivityBean from an EventHandlerTemplateData object.

Parameters:
origin - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.

EventActivityBean

public EventActivityBean(com.ibm.bpe.api.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 for 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 for the property.
locale - The locale.
Returns:
The label or the resource bundle key for the property.

isValid

public static boolean isValid(java.lang.String propertyName)
Checks if 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 com.ibm.bpe.api.ATID getATID()
Returns the property ATID.


getDescription

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


getEHTID

public com.ibm.bpe.api.EHTID getEHTID()
Returns the property EHTID.


getID

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


getInputMessageTypeName

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


getOperation

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


getPIID

public com.ibm.bpe.api.PIID getPIID()
Returns the property PIID.


getPortTypeName

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


getPortTypeNameSpace

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


getProcessTemplateName

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


getVTID

public com.ibm.bpe.api.VTID getVTID()
Returns the property VTID.


isEventHandler

public boolean isEventHandler()
Returns the property eventHandler. Checks if this event activity is generated from an event handler template data

Returns:
true if this activity represents an event handler

getInputMessageWrapper

public MessageWrapper getInputMessageWrapper()
                                      throws ClientException
Retrieves the input message.

Returns:
The wrapped message.
Throws:
ClientException