com.ibm.bpe.clientmodel.bean
Class ProcessTemplateBean

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

public class ProcessTemplateBean
extends java.lang.Object
implements com.ibm.bpe.api.ProcessTemplateData

Accesses the properties of the original ProcessTemplateData object and adds metadata for national language support and converters.

A ProcessTemplateBean object can be instantiated from a ProcessTemplateData 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:
ProcessTemplateData, Serialized Form

Field Summary
static java.lang.String APPLICATIONNAME_PROPERTY
          Use the property name to determine labels and converters for the property applicationName .
static java.lang.String AUTODELETE_PROPERTY
          Use the property name to determine labels and converters for the property autoDelete.
static java.lang.String AUTONOMY_PROPERTY
          Use the property name to determine labels and converters for the property autonomy.
static java.lang.String AVAILABLEACTIONS_PROPERTY
          Use the property name to determine labels and converters for the property availableActions.
static java.lang.String COMPENSATIONDEFINED_PROPERTY
          Use the property name to determine labels and converters for the property compensationDefined.
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
static java.lang.String CREATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property creationTime.
static java.lang.String DESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the property description.
static java.lang.String DISPLAYNAME_PROPERTY
          Use the property name to determine labels and converters for the property displayName.
static java.lang.String DOCUMENTATION_PROPERTY
          Use the property name to determine labels and converters for the property documentation.
static java.lang.String EXECUTIONMODE_PROPERTY
          Use the property name to determine labels and converters for the property execution mode.
static java.lang.String ID_PROPERTY
          Use the property name to determine labels and converters for the property ID.
static java.lang.String INPUTMESSAGETYPENAME_PROPERTY
          Use the property name to determine labels and converters for the property inputMessageTypeName.
static java.lang.String INPUTMESSAGETYPETYPESYSTEM_PROPERTY
          Use the property name to determine labels and converters for the property inputMessageTypeTypeSystem.
static java.lang.String LASTMODIFICATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the property lastModificationTime.
static java.lang.String NAME_PROPERTY
          Use the property name to determine labels and converters for the property name.
static java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
          Use the property name to determine labels and converters for the property outputMessageTypeName.
static java.lang.String OUTPUTMESSAGETYPETYPESYSTEM_PROPERTY
          Use the property name to determine labels and converters for the property outputMessageTypeTypeSystem.
static java.lang.String PROCESSADMINSTRATORS_PROPERTY
          Use the property name to determine labels and converters for the property processAdministrators.
static java.lang.String SCHEMAVERSION_PROPERTY
          Use the property name to determine labels and converters for the property schemaVersion.
static java.lang.String STATE_PROPERTY
          Use the property name to determine labels and converters for the property state.
static java.lang.String VALIDFROMTIME_PROPERTY
          Use the property name to determine labels and converters for the property validFromTime.
static java.lang.String VERSION_PROPERTY
          Use the property name to determine labels and converters for the property version.
 
Fields inherited from interface com.ibm.bpe.api.ProcessTemplateData
AUTONOMY_CHILD, AUTONOMY_NOT_APPLICABLE, AUTONOMY_PEER, EXECUTION_MODE_LONG_RUNNING, EXECUTION_MODE_MICROFLOW, KIND_BLOCK, KIND_PROCESS, SCHEMA_5_1, SCHEMA_5_1_1, SCHEMA_6_0, STATE_STARTED, STATE_STOPPED
 
Constructor Summary
ProcessTemplateBean(com.ibm.bpe.api.ProcessTemplateData data, BFMConnection bfmConnection)
          Constructs a new ProcessTemplateBean from an original ProcessTemplateData object.
 
Method Summary
 java.util.List getActivityServiceTemplates()
          Returns the list of starting activities for the process template.
 java.lang.String getApplicationName()
          Returns the property applicationName.
 boolean getAutoDelete()
          Returns the property autoDelete.
 int getAutonomy()
          Returns the property autonomy.
 int[] getAvailableActions()
          Returns the property availableActions.
static SimpleConverter getConverter(java.lang.String propertyName)
          Returns the default converter for a given property.
 java.util.Calendar getCreationTime()
          Returns the property creationTime.
 java.lang.String getDescription()
          Returns the property description.
 java.lang.String getDisplayName()
          Returns the property displayName.
 java.lang.String getDocumentation()
          Returns the property documentation.
 int getExecutionMode()
          Returns the property executionMode.
 com.ibm.bpe.api.PTID getID()
          Returns the property ID.
 java.lang.String getInputMessageTypeName()
          Returns the property inputMessageTypeName.
 java.lang.String getInputMessageTypeTypeSystemName()
          Returns the property inputMessageTypeTypeSystemName.
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.util.Calendar getLastModificationTime()
          Returns the property lastModificationTime.
 java.lang.String getName()
          Returns the property name.
 java.lang.String getOutputMessageTypeName()
          Returns the property outputMessageTypeName.
 java.lang.String getOutputMessageTypeTypeSystemName()
          Returns the property outputMessageTypeTypeSystemName.
 com.ibm.bpe.api.StaffResultSet getProcessAdministrators()
          Returns the property processAdministrators.
 int getSchemaVersion()
          Returns the property schemaVersion.
 int getState()
          Returns the property state.
 java.lang.String getTargetNamespace()
          Returns the property targetNamespace.
 java.util.Calendar getValidFromTime()
          Returns the property validFromTime.
 java.lang.String getVersion()
          Returns the property version.
 boolean isBusinessRelevant()
          Returns the property businessRelevant.
 boolean isCompensationDefined()
          Returns the property compensationDefined.
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

APPLICATIONNAME_PROPERTY

public static final java.lang.String APPLICATIONNAME_PROPERTY
Use the property name to determine labels and converters for the property applicationName .

See Also:
Constant Field Values

AUTODELETE_PROPERTY

public static final java.lang.String AUTODELETE_PROPERTY
Use the property name to determine labels and converters for the property autoDelete.

See Also:
Constant Field Values

AUTONOMY_PROPERTY

public static final java.lang.String AUTONOMY_PROPERTY
Use the property name to determine labels and converters for the property autonomy.

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 availableActions.

See Also:
Constant Field Values

COMPENSATIONDEFINED_PROPERTY

public static final java.lang.String COMPENSATIONDEFINED_PROPERTY
Use the property name to determine labels and converters for the property compensationDefined.

See Also:
Constant Field Values

CREATIONTIME_PROPERTY

public static final java.lang.String CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property creationTime.

See Also:
Constant Field Values

DESCRIPTION_PROPERTY

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

See Also:
Constant Field Values

DISPLAYNAME_PROPERTY

public static final java.lang.String DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the property displayName.

See Also:
Constant Field Values

DOCUMENTATION_PROPERTY

public static final java.lang.String DOCUMENTATION_PROPERTY
Use the property name to determine labels and converters for the property documentation.

See Also:
Constant Field Values

EXECUTIONMODE_PROPERTY

public static final java.lang.String EXECUTIONMODE_PROPERTY
Use the property name to determine labels and converters for the property execution mode.

See Also:
Constant Field Values

ID_PROPERTY

public static final java.lang.String ID_PROPERTY
Use the property name to determine labels and converters for the property ID.

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 inputMessageTypeName.

See Also:
Constant Field Values

INPUTMESSAGETYPETYPESYSTEM_PROPERTY

public static final java.lang.String INPUTMESSAGETYPETYPESYSTEM_PROPERTY
Use the property name to determine labels and converters for the property inputMessageTypeTypeSystem.

See Also:
Constant Field Values

LASTMODIFICATIONTIME_PROPERTY

public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property lastModificationTime.

See Also:
Constant Field Values

NAME_PROPERTY

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

See Also:
Constant Field Values

OUTPUTMESSAGETYPENAME_PROPERTY

public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the property outputMessageTypeName.

See Also:
Constant Field Values

OUTPUTMESSAGETYPETYPESYSTEM_PROPERTY

public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEM_PROPERTY
Use the property name to determine labels and converters for the property outputMessageTypeTypeSystem.

See Also:
Constant Field Values

PROCESSADMINSTRATORS_PROPERTY

public static final java.lang.String PROCESSADMINSTRATORS_PROPERTY
Use the property name to determine labels and converters for the property processAdministrators.

See Also:
Constant Field Values

SCHEMAVERSION_PROPERTY

public static final java.lang.String SCHEMAVERSION_PROPERTY
Use the property name to determine labels and converters for the property schemaVersion.

See Also:
Constant Field Values

STATE_PROPERTY

public static final java.lang.String STATE_PROPERTY
Use the property name to determine labels and converters for the property state.

See Also:
Constant Field Values

VALIDFROMTIME_PROPERTY

public static final java.lang.String VALIDFROMTIME_PROPERTY
Use the property name to determine labels and converters for the property validFromTime.

See Also:
Constant Field Values

VERSION_PROPERTY

public static final java.lang.String VERSION_PROPERTY
Use the property name to determine labels and converters for the property version.

See Also:
Constant Field Values
Constructor Detail

ProcessTemplateBean

public ProcessTemplateBean(com.ibm.bpe.api.ProcessTemplateData data,
                           BFMConnection bfmConnection)
Constructs a new ProcessTemplateBean from an original ProcessTemplateData object.

Parameters:
data - 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.

getApplicationName

public java.lang.String getApplicationName()
Returns the property applicationName.

Specified by:
getApplicationName in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getApplicationName()

getAutoDelete

public boolean getAutoDelete()
Returns the property autoDelete.

Specified by:
getAutoDelete in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getAutoDelete()

getAutonomy

public int getAutonomy()
Returns the property autonomy.

Specified by:
getAutonomy in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getAutonomy()

getAvailableActions

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

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

getCreationTime

public java.util.Calendar getCreationTime()
Returns the property creationTime.

Specified by:
getCreationTime in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getCreationTime()

getDescription

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

Specified by:
getDescription in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getDescription()

getDisplayName

public java.lang.String getDisplayName()
Returns the property displayName.

Specified by:
getDisplayName in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getDisplayName()

getDocumentation

public java.lang.String getDocumentation()
Returns the property documentation.

Specified by:
getDocumentation in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getDocumentation()

getExecutionMode

public int getExecutionMode()
Returns the property executionMode.

Specified by:
getExecutionMode in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getExecutionMode()

getID

public com.ibm.bpe.api.PTID getID()
Returns the property ID.

Specified by:
getID in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getID()

getInputMessageTypeName

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

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

getInputMessageTypeTypeSystemName

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

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

getLastModificationTime

public java.util.Calendar getLastModificationTime()
Returns the property lastModificationTime.

Specified by:
getLastModificationTime in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getLastModificationTime()

getName

public java.lang.String getName()
Returns the property name.

Specified by:
getName in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getName()

getOutputMessageTypeName

public java.lang.String getOutputMessageTypeName()
Returns the property outputMessageTypeName.

Specified by:
getOutputMessageTypeName in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getOutputMessageTypeName()

getOutputMessageTypeTypeSystemName

public java.lang.String getOutputMessageTypeTypeSystemName()
Returns the property outputMessageTypeTypeSystemName.

Specified by:
getOutputMessageTypeTypeSystemName in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getOutputMessageTypeTypeSystemName()

getProcessAdministrators

public com.ibm.bpe.api.StaffResultSet getProcessAdministrators()
                                                        throws com.ibm.bpe.api.WorkItemManagerException,
                                                               com.ibm.bpe.api.InvalidLengthException
Returns the property processAdministrators.

Specified by:
getProcessAdministrators in interface com.ibm.bpe.api.ProcessTemplateData
Throws:
com.ibm.bpe.api.WorkItemManagerException
com.ibm.bpe.api.InvalidLengthException
See Also:
ProcessTemplateData.getProcessAdministrators()

getSchemaVersion

public int getSchemaVersion()
Returns the property schemaVersion.

Specified by:
getSchemaVersion in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getSchemaVersion()

getState

public int getState()
Returns the property state.

Specified by:
getState in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getState()

getTargetNamespace

public java.lang.String getTargetNamespace()
Returns the property targetNamespace.

Specified by:
getTargetNamespace in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getTargetNamespace()

getValidFromTime

public java.util.Calendar getValidFromTime()
Returns the property validFromTime.

Specified by:
getValidFromTime in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getValidFromTime()

getVersion

public java.lang.String getVersion()
Returns the property version.

Specified by:
getVersion in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.getVersion()

isBusinessRelevant

public boolean isBusinessRelevant()
Returns the property businessRelevant.

Specified by:
isBusinessRelevant in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.isBusinessRelevant()

isCompensationDefined

public boolean isCompensationDefined()
Returns the property compensationDefined.

Specified by:
isCompensationDefined in interface com.ibm.bpe.api.ProcessTemplateData
See Also:
ProcessTemplateData.isCompensationDefined()

getActivityServiceTemplates

public java.util.List getActivityServiceTemplates()
                                           throws ClientException
Returns the list of starting activities for the process template.

Returns:
A list of starting activities as ActivityServiceTemplateBean objects.
Throws:
ClientException