com.ibm.bpe.clientmodel.bean
Class ActivityServiceTemplateBean

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

public class ActivityServiceTemplateBean
extends java.lang.Object
implements com.ibm.bpe.api.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. The return value may be null because converters are optional.

See Also:
ActivityServiceTemplateData, Serialized Form

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

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 property activity description.

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 property activity display name.

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 property activity name.

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 property available actions.

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 property input message type name.

See Also:
Constant Field Values

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

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

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 property operation name.

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 property partner link name.

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 property port type.

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 property port type namespace.

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 property process template ID.

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 property service template ID.

See Also:
Constant Field Values
Constructor Detail

ActivityServiceTemplateBean

public ActivityServiceTemplateBean(com.ibm.bpe.api.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 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.

getActivityDescription

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

Specified by:
getActivityDescription in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityDescription()

getActivityDisplayName

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

Specified by:
getActivityDisplayName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityDisplayName()

getActivityName

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

Specified by:
getActivityName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityName()

getActivityTemplateID

public com.ibm.bpe.api.ATID getActivityTemplateID()
Returns the property activityTemplateID.

Specified by:
getActivityTemplateID in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getActivityTemplateID()

getAvailableActions

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

Specified by:
getAvailableActions in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getAvailableActions()

getID

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

Returns:
The service template's id serves as the identifier for this object.

getInputMessageTypeName

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

Specified by:
getInputMessageTypeName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getInputMessageTypeName()

getInputMessageTypeTypeSystemName

public java.lang.String getInputMessageTypeTypeSystemName()
Returns the property inputMessageTypeTypeSystemName.

Specified by:
getInputMessageTypeTypeSystemName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getInputMessageTypeTypeSystemName()

getOperationName

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

Specified by:
getOperationName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getOperationName()

getPartnerLinkName

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

Specified by:
getPartnerLinkName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPartnerLinkName()

getPortTypeName

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

Specified by:
getPortTypeName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPortTypeName()

getPortTypeNamespace

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

Specified by:
getPortTypeNamespace in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getPortTypeNamespace()

getProcessTemplateID

public com.ibm.bpe.api.PTID getProcessTemplateID()
Returns the property processTemplateID.

Specified by:
getProcessTemplateID in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getProcessTemplateID()

getProcessTemplateName

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

Specified by:
getProcessTemplateName in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getProcessTemplateName()

getServiceTemplateID

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

Specified by:
getServiceTemplateID in interface com.ibm.bpe.api.ActivityServiceTemplateData
See Also:
ActivityServiceTemplateData.getServiceTemplateID()

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