com.ibm.commerce.ubf.registry

Class BusinessFlow

java.lang.Object

com.ibm.commerce.ubf.registry.BusinessFlowBase

com.ibm.commerce.ubf.registry.BusinessFlow

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

CompositeBusinessFlow, DynamicBusinessFlow

public class BusinessFlow
extends BusinessFlowBase
implements java.io.Serializable

Encapsulates the data and logic for business flow.

BusinessFlows are contained by BusinessFlowTypes. Each BusinessFlow instance belongs to exactly one BusinessFlowType. BusinessFlows contain BusinessFlowTransitions.

This class is immutable to objects outside of it's package. The arrays returned by methods are copies.

BusinessFlows have states, BusinessFlowStates. States may be shared among different BusinessFlows. To associate different entry actions, exit actions, and response views for the different BusinessFlows, BusinessFlows contain BusinessFlowStateRelations.

See Also:

BusinessFlowDomain, BusinessFlowState, BusinessFlowType, BusinessFlowStateRelations, BusinessFlowTransition, BusinessFlowStateGroup, CompositeBusinessFlow, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BusinessFlow(java.lang.Long id, java.lang.String identifier, java.lang.Integer priority, java.lang.Long flowTypeId, java.lang.String attribute, java.lang.Integer languageId, boolean compositeFlow, java.lang.String shortDescription, java.lang.String description) Constructs a new BusinessFlow with the specified values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute() The string value attribute that further describes this BusinessFlow.
BusinessFlowStateRelation[]	getBusinessFlowStateRelations() BusinessFlows have states, BusinessFlowStates.
BusinessFlowTransition[]	getBusinessFlowTransitions() The BusinessFlowTransitions belonging to this BusinessFlow.
BusinessFlowType	getBusinessFlowType() BusinessFlows are contained by BusinessFlowTypes.
java.lang.Long	getBusinessFlowTypeID() The owning BusinessFlowType unique id value
java.lang.String	getDescription(java.lang.Integer langId) Descriptions may be associated with multiple languages.
java.lang.String	getShortDescription(java.lang.Integer langId) Descriptions may be associated with multiple languages.
boolean	isCompositeFlow() Indicates whether this BusinessFlow is a composition of flows.
java.lang.String	toString() Returns a String object representing this BusinessFlow and it's associated values.

Methods inherited from class com.ibm.commerce.ubf.registry.BusinessFlowBase

compareTo, getID, getIdentifier, getPriority

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessFlow

public BusinessFlow(java.lang.Long id,
                    java.lang.String identifier,
                    java.lang.Integer priority,
                    java.lang.Long flowTypeId,
                    java.lang.String attribute,
                    java.lang.Integer languageId,
                    boolean compositeFlow,
                    java.lang.String shortDescription,
                    java.lang.String description)

Constructs a new BusinessFlow with the specified values.

Parameters:

id - The unique id value for this BusinessFlow.

identifier - The unique string identifier for this BusinessFlow.

priority - The display sequence priority for this BusinessFlow.

flowTypeId - The flow type id value to which this BusinessFlow belongs to.

attribute - A string value attribute that further describes this BusinessFlow.

languageId - The default language id value indicating the language used for the default short and long description values.

compositeFlow - A Flag to indicate if this BusinessFlow is a composition of flows.

shortDescription - The default short description for this BusinessFlow in the language specified by the languageId value.

description - The default long description for this BusinessFlow in the language specified by the languageId value.

Method Detail

getAttribute

public java.lang.String getAttribute()

The string value attribute that further describes this BusinessFlow.

Returns:

The BusinessFlow attribute value.

getBusinessFlowStateRelations

public BusinessFlowStateRelation[] getBusinessFlowStateRelations()

BusinessFlows have states, BusinessFlowStates. States may be shared among different BusinessFlows. To associate different entry actions, exit actions, and response views for the different BusinessFlows, BusinessFlows contain BusinessFlowStateRelations.

Returns:

An array copy of BusinessFlowStateRelations, null if no BusinessFlowStateRelations exist for this BusinessFlow.

See Also:

BusinessFlowStateRelations

getBusinessFlowTransitions

public BusinessFlowTransition[] getBusinessFlowTransitions()

The BusinessFlowTransitions belonging to this BusinessFlow.

Returns:

An array copy of BusinessFlowTransitions belonging to this BusinessFlow, null if no BusinessFlowTransitions exist for this BusinessFlow.

See Also:

BusinessFlowTransition

getBusinessFlowType

public BusinessFlowType getBusinessFlowType()

BusinessFlows are contained by BusinessFlowTypes. This method returns the owning BusinessFlowType for this BusinessFlow.

Returns:

The owner of this BusinessFlow.

See Also:

BusinessFlowType

getBusinessFlowTypeID

public java.lang.Long getBusinessFlowTypeID()

The owning BusinessFlowType unique id value

Returns:

The owning BusinessFlowType unique id value.

See Also:

getBusinessFlowType(), BusinessFlowType

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

Overrides:

getDescription in class BusinessFlowBase

Parameters:

langId - The language id value.

Returns:

The description value for the specified language.

getShortDescription

public java.lang.String getShortDescription(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 short description value for the specified language.

isCompositeFlow

public boolean isCompositeFlow()

Indicates whether this BusinessFlow is a composition of flows.

Returns:

true if this BusinessFlow is a composite flow, false otherwise

toString

public java.lang.String toString()

Returns a String object representing this BusinessFlow and it's associated values.

Overrides:

toString in class BusinessFlowBase

Returns:

A string representation of this BusinessFlow.