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