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
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.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
ACTIVITY_DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the
description property.
|
|
ACTIVITY_EVENTHANDLER_PROPERTY
Use the property name to determine labels and converters for the
eventHandler property.
|
|
ACTIVITY_OPERATIONNAME_PROPERTY
Use the property name to determine labels and converters for the
operation property.
|
|
ACTIVITY_PORTTYPENAME_PROPERTY
Use the property name to determine labels and converters for the
portTypeName property.
|
|
ACTIVITY_PORTTYPENAMESPACE_PROPERTY
Use the property name to determine labels and converters for the
portTypeNameSpace property.
|
|
COPYRIGHT
|
|
PROCESSINSTANCE_ID_PROPERTY
Use the property name to determine labels and converters for the
PIID property.
|
|
PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
Use the property name to determine labels and converters for the
inputMessageTypeName property.
|
|
PROCESSTEMPLATE_ID_PROPERTY
Use the property name to determine labels and converters for the
processTemplateId property.
|
|
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 |
---|---|
getATID()
Returns the
ATID .
|
|
|
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
|
getDescription()
Returns the
description .
|
getEHTID()
Returns the
EHTID .
|
|
|
getID()
Returns the
ID .
|
|
getInputMessageTypeName()
Returns the
inputMessageTypeName property.
|
getInputMessageWrapper()
Retrieves the input message.
|
|
|
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property.
|
|
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label for a property from the resource bundle.
|
|
getOperation()
Returns the
operation property.
|
getPIID()
Returns the
PIID property.
|
|
|
getPortTypeName()
Returns the
portTypeName property.
|
|
getPortTypeNameSpace()
Returns the
portTypeNameSpace property.
|
getProcessTemplateId()
Returns the
processTemplateId property.
|
|
|
getProcessTemplateName()
Returns the
processTemplateName property.
|
getVTID()
Returns the
VTID property.
|
|
|
isEventHandler()
Returns the
eventHandler property.
|
|
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
COPYRIGHT
- public static final java.lang.String COPYRIGHT
ACTIVITY_DESCRIPTION_PROPERTY
- public static java.lang.String ACTIVITY_DESCRIPTION_PROPERTY
ACTIVITY_PORTTYPENAME_PROPERTY
- public static java.lang.String ACTIVITY_PORTTYPENAME_PROPERTY
portTypeName
property.
ACTIVITY_OPERATIONNAME_PROPERTY
- public static java.lang.String ACTIVITY_OPERATIONNAME_PROPERTY
operation
property.
PROCESSINSTANCE_ID_PROPERTY
- public static java.lang.String PROCESSINSTANCE_ID_PROPERTY
PIID
property.
PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
- public static java.lang.String PROCESSINSTANCE_INPUTMESSAGE_PROPERTY
inputMessageTypeName
property.
ACTIVITY_PORTTYPENAMESPACE_PROPERTY
- public static java.lang.String ACTIVITY_PORTTYPENAMESPACE_PROPERTY
portTypeNameSpace
property.
PROCESSTEMPLATE_NAME_PROPERTY
- public static java.lang.String PROCESSTEMPLATE_NAME_PROPERTY
processTemplateName
property.
PROCESSTEMPLATE_ID_PROPERTY
- public static java.lang.String PROCESSTEMPLATE_ID_PROPERTY
processTemplateId
property.
ACTIVITY_EVENTHANDLER_PROPERTY
- public static java.lang.String ACTIVITY_EVENTHANDLER_PROPERTY
eventHandler
property.
Constructor Detail
EventActivityBean
- public EventActivityBean(ActivityServiceTemplateData ast,
- BFMConnection bfmConnection,
- PIID piid)
EventyActivityBean
from an original
ActivityServiceTemplateData
object.
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)
EventyActivityBean
from an
EventHandlerTemplateData
object.
origin
- 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)
EventyActivityBean
from an
EventHandlerTemplateData
object.
origin
- The original data object. bfmConnection
- The connection to the BusinessFlowManagerService API. EventActivityBean
- public EventActivityBean(QueryResultSet resultSet)
EventActivityBean
from a
QueryResultSet
.
resultSet
- The result object of a query. Method Detail
getConverter
- public static SimpleConverter getConverter( java.lang.String propertyName)
propertyName
- The name of the property. propertyName
, null otherwise. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName)
propertyName
- The name for the property. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName,
- java.util.Locale locale)
propertyName
- The name of the property. locale
- The locale. isValid
- public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked. propertyName
is a known property for
an object of this class. getATID
- public ATID getATID()
ATID
.
getDescription
- public java.lang.String getDescription( )
description
.
getEHTID
- public EHTID getEHTID()
EHTID
.
getID
- public java.lang.String getID()
ID
.
getInputMessageTypeName
- public java.lang.String getInputMessageTypeName( )
inputMessageTypeName
property.
getOperation
- public java.lang.String getOperation( )
operation
property.
getPIID
- public PIID getPIID()
PIID
property.
getPortTypeName
- public java.lang.String getPortTypeName( )
portTypeName
property.
getPortTypeNameSpace
- public java.lang.String getPortTypeNameSpace( )
portTypeNameSpace
property.
getProcessTemplateName
- public java.lang.String getProcessTemplateName( )
processTemplateName
property.
getProcessTemplateId
- public PTID getProcessTemplateId( )
processTemplateId
property.
getVTID
- public VTID getVTID()
VTID
property.
isEventHandler
- public boolean isEventHandler()
eventHandler
property. Checks whether this
event activity is generated from an event handler template data.
getInputMessageWrapper
- public MessageWrapper getInputMessageWrapper( )
- throws ClientException
description
property.