com.ibm.commerce.ubf.registry

Class BusinessFlowState

java.lang.Object

com.ibm.commerce.ubf.registry.BusinessFlowState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

DynamicBusinessFlowState

public class BusinessFlowState
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

BusinessFlowStates are contained by BusinessFlowTypes and may be grouped by BusinessFlowStateGroups. Each BusinessFlowSate may be associated with BusinessFlows through BusinessFlowStateRelations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	END_STATE
static java.lang.Integer	NORMAL_STATE
static java.lang.Integer	START_STATE

Constructor Summary

Constructors

Constructor and Description
BusinessFlowState(java.lang.Long id, java.lang.Integer identifier, java.lang.String stateName, java.lang.Long flowTypeId, java.lang.Long flowStateGroupId, java.lang.String approverMemberGroupName, java.lang.Integer languageId, java.lang.String description, java.lang.Integer stateType) Constructs a new BusinessFlowState with the specified values.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object otherObject) Compares current object to another object.
java.lang.String	getApproverMemberGroupName() Returns the approver group name string.
BusinessFlowStateGroup	getBusinessFlowStateGroup() Returns the BusinessFlowStateGroup value.
java.lang.Long	getBusinessFlowStateGroupID() Returns the BusinessFlowStateGroup unique id value.
BusinessFlowStateRelation[]	getBusinessFlowStateRelations()
BusinessFlowType	getBusinessFlowType()
java.lang.Long	getBusinessFlowTypeID()
java.lang.String	getDescription(java.lang.Integer langId) Descriptions may be associated with multiple languages.
java.lang.Long	getID()
java.lang.Integer	getIdentifier()
java.lang.String	getStateName()
java.lang.Integer	getStateType()
java.lang.String	toString() Returns the string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

END_STATE

public static final java.lang.Integer END_STATE

NORMAL_STATE

public static final java.lang.Integer NORMAL_STATE

START_STATE

public static final java.lang.Integer START_STATE

Constructor Detail

BusinessFlowState

public BusinessFlowState(java.lang.Long id,
                         java.lang.Integer identifier,
                         java.lang.String stateName,
                         java.lang.Long flowTypeId,
                         java.lang.Long flowStateGroupId,
                         java.lang.String approverMemberGroupName,
                         java.lang.Integer languageId,
                         java.lang.String description,
                         java.lang.Integer stateType)

Constructs a new BusinessFlowState with the specified values.

Parameters:

id - The BusinessFlowState unique long value.

identifier - The BusinessFlowState identifier.

stateName - The BusinessFlowState Name.

flowTypeId - The BusinessFlowState FlowType Id.

flowStateGroupId - The BusinessFlowState Group.

approverMemberGroupName - The approver group name.

languageId - The Language id.

description - The Description String.

stateType - The State type.

Method Detail

compareTo

public int compareTo(java.lang.Object otherObject)

Compares current object to another object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

otherObject - The other object for the comparision.

Returns:

0 if objects are equal, 1 if this object is greater than otherObject, -1 if otherObject is greater than this object.

getApproverMemberGroupName

public java.lang.String getApproverMemberGroupName()

Returns the approver group name string.

Returns:

The approver group name string.

getBusinessFlowStateGroup

public BusinessFlowStateGroup getBusinessFlowStateGroup()

Returns the BusinessFlowStateGroup value.

Returns:

The BusinessFlowStateGroup value.

getBusinessFlowStateGroupID

public java.lang.Long getBusinessFlowStateGroupID()

Returns the BusinessFlowStateGroup unique id value.

Returns:

The BusinessFlowStateGroup unique id value.

getBusinessFlowStateRelations

public BusinessFlowStateRelation[] getBusinessFlowStateRelations()

Returns:

An array of BusinessFlowStateRelations associated with this BusinessFlowState, null if no associations exist.

getBusinessFlowType

public BusinessFlowType getBusinessFlowType()

Returns:

The owning BusinessFlowType value.

getBusinessFlowTypeID

public java.lang.Long getBusinessFlowTypeID()

Returns:

The owning BusinessFlowType unique id value.

getDescription

public java.lang.String getDescription(java.lang.Integer langId)

Descriptions may be associated with multiple languages. Use the language id to return the appropriate language description. If the BusinessFlowRegistry cache is enabled and the specified language description is not in the cache then this classes uses the associated EJB Access Bean to return the value and adds a request to the BusinessFlowRegistry to load all of the descriptions for the language into the cache.

Parameters:

langId - The language integer id value.

Returns:

The description value for the specified language.

getID

public java.lang.Long getID()

Returns:

The BusinessFlowState unique id value.

getIdentifier

public java.lang.Integer getIdentifier()

Returns:

The identifier value.

getStateName

public java.lang.String getStateName()

Returns:

The state name.

getStateType

public java.lang.Integer getStateType()

Returns:

The state type value.

toString

public java.lang.String toString()

Returns the string representation.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the Object.