IBM WebSphere Application ServerTM
Release 7

com.ibm.bpe.clientmodel.bean
Class ActivityServiceTemplateBean

java.lang.Object
  extended by com.ibm.bpe.clientmodel.bean.ActivityServiceTemplateBean
All Implemented Interfaces:
ActivityServiceTemplateData, java.io.Serializable

public class ActivityServiceTemplateBean
extends java.lang.Object
implements ActivityServiceTemplateData

Accesses the properties of the original ActivityServiceTemplateData object and adds metadata for national language support and converters. An ActivityServiceTemplateBean object can be instantiated from an ActivityServiceTemplateData object.

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

See Also:
ActivityServiceTemplateData, Serialized Form

Field Summary
static java.lang.String ACTIVITYDESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the "activity description" property.
static java.lang.String ACTIVITYDISPLAYNAME_PROPERTY
          Use the property name to determine labels and converters for the "activity display name" property.
static java.lang.String ACTIVITYNAME_PROPERTY
          Use the property name to determine labels and converters for the "activity name" property.
static java.lang.String AVAILABLEACTIONS_PROPERTY
          Use the property name to determine labels and converters for the "available actions" property.
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2004, 2008.
static java.lang.String INPUTMESSAGETYPENAME_PROPERTY
          Use the property name to determine labels and converters for the "input message type name" property.
static java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
          Deprecated.  
static java.lang.String OPERATIONNAME_PROPERTY
          Use the property name to determine labels and converters for the "operation name" property.
static java.lang.String PARTNERLINKNAME_PROPERTY
          Use the property name to determine labels and converters for the "partner link name" property.
static java.lang.String PORTTYPENAME_PROPERTY
          Use the property name to determine labels and converters for the "port type" property.
static java.lang.String PORTTYPENAMESPACE_PROPERTY
          Use the property name to determine labels and converters for the "port type namespace" property.
static java.lang.String PROCESSTEMPLATEID_PROPERTY
          Use the property name to determine labels and converters for the "process template ID" property.
static java.lang.String SERVICETEMPLATEID_PROPERTY
          Use the property name to determine labels and converters for the "service template ID" property.
 
Constructor Summary
ActivityServiceTemplateBean(ActivityServiceTemplateData activityTemplate, BFMConnection bfmConnection)
          Constructs a new ActivityServiceTemplateBean from an original ActivityServiceTemplateData object.
 
Method Summary
 java.lang.String getActivityDescription()
          Returns the activityDescription property.
 java.lang.String getActivityDisplayName()
          Returns the activityDisplayName property.
 java.lang.String getActivityName()
          Returns the activityName property.
 ATID getActivityTemplateID()
          Returns the activityTemplateID property.
 int[] getAvailableActions()
          Returns the availableActions property.
static SimpleConverter getConverter(java.lang.String propertyName)
          Returns the default converter for a given property.
 OID getID()
          Returns the ID property.
 java.lang.String getInputMessageTypeName()
          Returns the inputMessageTypeName property.
 java.lang.String getInputMessageTypeTypeSystemName()
          Deprecated.  
 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 of a property from the resource bundle.
 java.lang.String getOperationName()
          Returns the operationName property.
 java.lang.String getPartnerLinkName()
          Returns the partnerLinkName property.
 java.lang.String getPortTypeName()
          Returns the portTypeName property.
 java.lang.String getPortTypeNamespace()
          Returns the portTypeNamespace property.
 ProcessTemplateBean getProcessTemplate()
          Returns a ProcessTemplateBean object for the associated ProcessTemplateData object.
 PTID getProcessTemplateID()
          Returns the processTemplateID property.
 java.lang.String getProcessTemplateName()
          Returns the processTemplateName property.
 VTID getServiceTemplateID()
          Returns the serviceTemplateID property.
 TKTID getTaskTemplateID()
          Returns the taskTemplateID property.
 boolean isTwoWayOperation()
          Returns the twoWayOperation property.
static boolean isValid(java.lang.String propertyName)
          Checks that 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 2004, 2008.

See Also:
Constant Field Values

ACTIVITYDESCRIPTION_PROPERTY

public static final java.lang.String ACTIVITYDESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the "activity description" property.

See Also:
Constant Field Values

ACTIVITYDISPLAYNAME_PROPERTY

public static final java.lang.String ACTIVITYDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the "activity display name" property.

See Also:
Constant Field Values

ACTIVITYNAME_PROPERTY

public static final java.lang.String ACTIVITYNAME_PROPERTY
Use the property name to determine labels and converters for the "activity name" property.

See Also:
Constant Field Values

AVAILABLEACTIONS_PROPERTY

public static final java.lang.String AVAILABLEACTIONS_PROPERTY
Use the property name to determine labels and converters for the "available actions" property.

See Also:
Constant Field Values

INPUTMESSAGETYPENAME_PROPERTY

public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the "input message type name" property.

See Also:
Constant Field Values

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated. 
Use the property name to determine labels and converters for the "input message type system name" property.

See Also:
Constant Field Values

OPERATIONNAME_PROPERTY

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

See Also:
Constant Field Values

PARTNERLINKNAME_PROPERTY

public static final java.lang.String PARTNERLINKNAME_PROPERTY
Use the property name to determine labels and converters for the "partner link name" property.

See Also:
Constant Field Values

PORTTYPENAME_PROPERTY

public static final java.lang.String PORTTYPENAME_PROPERTY
Use the property name to determine labels and converters for the "port type" property.

See Also:
Constant Field Values

PORTTYPENAMESPACE_PROPERTY

public static final java.lang.String PORTTYPENAMESPACE_PROPERTY
Use the property name to determine labels and converters for the "port type namespace" property.

See Also:
Constant Field Values

PROCESSTEMPLATEID_PROPERTY

public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
Use the property name to determine labels and converters for the "process template ID" property.

See Also:
Constant Field Values

SERVICETEMPLATEID_PROPERTY

public static final java.lang.String SERVICETEMPLATEID_PROPERTY
Use the property name to determine labels and converters for the "service template ID" property.

See Also:
Constant Field Values
Constructor Detail

ActivityServiceTemplateBean

public ActivityServiceTemplateBean(ActivityServiceTemplateData activityTemplate,
                                   BFMConnection bfmConnection)
Constructs a new ActivityServiceTemplateBean from an original ActivityServiceTemplateData object.

Parameters:
activityTemplate - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.
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 of 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 of 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 that the property is valid.

Parameters:
propertyName - The name of the property to be checked.
Returns:
True if propertyName is a known property for an object of this class.

getActivityDescription

public java.lang.String getActivityDescription()
Returns the activityDescription property.

Specified by:
getActivityDescription in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityDescription()

getActivityDisplayName

public java.lang.String getActivityDisplayName()
Returns the activityDisplayName property.

Specified by:
getActivityDisplayName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityDisplayName()

getActivityName

public java.lang.String getActivityName()
Returns the activityName property.

Specified by:
getActivityName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityName()

getActivityTemplateID

public ATID getActivityTemplateID()
Returns the activityTemplateID property.

Specified by:
getActivityTemplateID in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityTemplateID()

getAvailableActions

public int[] getAvailableActions()
Returns the availableActions property.

Specified by:
getAvailableActions in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getAvailableActions()

getID

public OID getID()
Returns the ID property. Addition to the interface to guarantee that this object has an identifier.

Returns:
The service template's ID is used as the identifier for this object.

getInputMessageTypeName

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

Specified by:
getInputMessageTypeName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getInputMessageTypeName()

getInputMessageTypeTypeSystemName

public java.lang.String getInputMessageTypeTypeSystemName()
Deprecated. 

Returns the inputMessageTypeTypeSystemName property.

Specified by:
getInputMessageTypeTypeSystemName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getInputMessageTypeTypeSystemName()

getOperationName

public java.lang.String getOperationName()
Returns the operationName property.

Specified by:
getOperationName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getOperationName()

getPartnerLinkName

public java.lang.String getPartnerLinkName()
Returns the partnerLinkName property.

Specified by:
getPartnerLinkName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPartnerLinkName()

getPortTypeName

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

Specified by:
getPortTypeName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPortTypeName()

getPortTypeNamespace

public java.lang.String getPortTypeNamespace()
Returns the portTypeNamespace property.

Specified by:
getPortTypeNamespace in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPortTypeNamespace()

getProcessTemplateID

public PTID getProcessTemplateID()
Returns the processTemplateID property.

Specified by:
getProcessTemplateID in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getProcessTemplateID()

getTaskTemplateID

public TKTID getTaskTemplateID()
Returns the taskTemplateID property.

Specified by:
getTaskTemplateID in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getTaskTemplateID()

getProcessTemplateName

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

Specified by:
getProcessTemplateName in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getProcessTemplateName()

getServiceTemplateID

public VTID getServiceTemplateID()
Returns the serviceTemplateID property.

Specified by:
getServiceTemplateID in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getServiceTemplateID()

isTwoWayOperation

public boolean isTwoWayOperation()
Returns the twoWayOperation property.

Specified by:
isTwoWayOperation in interface ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.isTwoWayOperation()

getProcessTemplate

public ProcessTemplateBean getProcessTemplate()
                                       throws ClientException
Returns a ProcessTemplateBean object for the associated ProcessTemplateData object.

Returns:
The process template.
Throws:
ClientException

getInputMessageWrapper

public MessageWrapper getInputMessageWrapper()
                                      throws ClientException
Retrieves the input message. If Web client settings are available, the context root and the URL are retrieved.

Returns:
The wrapped message and Web client settings.
Throws:
ClientException

IBM WebSphere Application ServerTM
Release 7