com.ibm.commerce.ubf.registry

Class BusinessFlowManager

java.lang.Object

com.ibm.commerce.ubf.registry.BusinessFlowManager

public class BusinessFlowManager
extends java.lang.Object

The class contains the methods to retrieve the various business flow class instances. This is a Singleton class which means only one instance of this class exists in the application. Use the static method getInstance() to retrieve the instance of the class.

This class should be used instead of the UBF Access beans. If the UBF registry cache is enabled then the BusinessFlowManager uses the business flow class instances created by the BusinessFlowRegistry class. If the registry cache is not enabled then it uses the Access beans to retrieve the data for the various business flow classes.

See Also:

BusinessFlowRegistry

Method Summary

Modifier and Type	Method and Description
CompositeBusinessFlow	getCompositeFlow(java.lang.Long compositeFlowId) Returns the CompositeBusinessFlow class instance in the registry cache for the specified compositeFlowId.
CompositeBusinessFlow[]	getCompositeFlows() Returns all of the CompositeBusinessFlow objects in the registry cache.
BusinessFlowDomain	getDomain(java.lang.Long businessFlowDomainId) Returns the BusinessFlowDomain class instance in the registry cache for the specified businessFlowDomainId.
BusinessFlowDomain[]	getDomains() Returns all of the BusinessFlowDomain objects in the registry cache.
BusinessFlow	getFlow(java.lang.Long businessFlowId) Returns the BusinessFlow class instance in the registry cache for the specified businessFlowId.
BusinessFlow	getFlowByFlowTypeIdentifierAndFlowIdentifier(java.lang.String aBusinessFlowTypeIdentifier, java.lang.String aFlowIdentifer) Returns a BusinessFlow object in the registry cache for the specified businessFlowTypeIdentifier and businessFlowIdentifier.
BusinessFlow[]	getFlows() Returns all of the BusinessFlow objects in the registry cache.
BusinessFlow[]	getFlowsByCompositeFlowId(java.lang.Long compositeFlowId) Returns all of the BusinessFlow objects in the registry cache for the specified compositeFlowId.
BusinessFlow[]	getFlowsByFlowTypeId(java.lang.Long businessFlowTypeId) Returns all of the BusinessFlow objects in the registry cache for the specified businessFlowTypeId.
BusinessFlowStateRelation	getFlowStateRelationByFlowIdAndStateId(java.lang.Long businessFlowId, java.lang.Long businessFlowStateId) Returns the BusinessFlowStateRelation class instance in the registry cache for the specified businessFlowId and the businessFlowStateId.
BusinessFlowStateRelation[]	getFlowStateRelations() Returns all of the BusinessFlowStateRelation objects in the registry cache.
BusinessFlowStateRelation[]	getFlowStateRelationsByFlowId(java.lang.Long businessFlowId) Returns all the BusinessFlowStateRelation objects in the registry cache for the specified businessFlowId.
BusinessFlowStateRelation[]	getFlowStateRelationsByStateId(java.lang.Long businessFlowStateId) Returns all the BusinessFlowStateRelation objects in the registry cache for the specified businessFlowStateId.
BusinessFlowType	getFlowType(java.lang.Long businessFlowTypeId) Returns the BusinessFlowType class instance in the registry cache for the specified businessFlowTypeId.
BusinessFlowType	getFlowTypeByIdentifier(java.lang.String flowTypeIdentifier) Returns the BusinessFlowType class instance in the registry cache for the specified flowTypeIdentifier.
BusinessFlowType[]	getFlowTypes() Returns all of the BusinessFlowType objects in the registry cache.
BusinessFlowType[]	getFlowTypesByDomainId(java.lang.Long businessFlowDomainId) Returns all of the BusinessFlowType objects in the registry cache for the specified businessFlowDomainId.
static BusinessFlowManager	getInstance() A static method to return a single instance of this class.
BusinessFlowState	getState(java.lang.Long businessFlowStateId) Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowStateId.
BusinessFlowState	getStateByFlowIdAndStateType(java.lang.Long businessFlowId, java.lang.Integer stateType) Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowId and stateType.
BusinessFlowState	getStateByFlowTypeIdAndIdentifier(java.lang.Long businessFlowTypeId, java.lang.Integer stateIdentifier) Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowTypeId and stateIndentifier.
BusinessFlowState	getStateByFlowTypeIdAndStateName(java.lang.Long businessFlowTypeId, java.lang.String stateName) Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowTypeId and stateName.
BusinessFlowStateGroup	getStateGroup(java.lang.Long businessFlowStateGroupId) Returns the BusinessFlowStateGroup class instance in the registry cache for the specified businessFlowStateGroupId.
BusinessFlowStateGroup	getStateGroupByFlowTypeIdAndIdentifier(java.lang.Long businessFlowTypeId, java.lang.String businessFlowStateGroupIdentifier) Returns the BusinessFlowStateGroup class instance in the registry cache for the specified businessFlowTypeId and the businessFlowStateGroupIdentifier.
BusinessFlowStateGroup[]	getStateGroups() Returns all of the BusinessFlowStateGroup objects in the registry cache.
BusinessFlowState[]	getStates() Returns all of the BusinessFlowState objects in the registry cache.
BusinessFlowState[]	getStatesByFlowId(java.lang.Long businessFlowId) Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowId.
BusinessFlowState[]	getStatesByFlowTypeId(java.lang.Long businessFlowTypeId) Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowTypeId.
BusinessFlowState[]	getStatesByStateGroupId(java.lang.Long businessFlowStateGroupId) Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowStateGroupId.
BusinessFlowTransition	getTransition(java.lang.Long businessFlowTransitionId) Returns the BusinessFlowTransition class instance in the registry cache for the specified businessFlowTransitionId.
BusinessFlowTransition	getTransitionByFlowIdAndSourceStateIdAndEventIdentifierAndTargetStateId(java.lang.Long flowId, java.lang.Long sourceStateId, java.lang.String eventIdentifier, java.lang.Long targetStateId) Returns the BusinessFlowTransition object in the registry cache for the specified businessFlowId, sourceStateId, eventIdentifier, and targetStateId.
BusinessFlowTransition[]	getTransitions() Returns all of the BusinessFlowTransitions objects in the registry cache.
BusinessFlowTransition[]	getTransitionsByFlowId(java.lang.Long businessFlowId) Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId.
BusinessFlowTransition[]	getTransitionsByFlowIdAndSourceStateId(java.lang.Long flowId, java.lang.Long sourceStateId) Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId and sourceStateId.
BusinessFlowTransition[]	getTransitionsByFlowIdAndSourceStateIdAndApproval(java.lang.Long flowId, java.lang.Long sourceStateId, java.lang.Integer approval) Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId, sourceStateId, and approval.
BusinessFlowTransition[]	getTransitionsByFlowIdAndSourceStateIdAndEventIdentifier(java.lang.Long flowId, java.lang.Long sourceStateId, java.lang.String eventIdentifier) Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId, sourceStateId, and eventIdentifier.
boolean	isCacheEnabled() Indicates whether the BusinessFlowRegistry cache is on or off.

Methods inherited from class java.lang.Object

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

Method Detail

getCompositeFlow

public CompositeBusinessFlow getCompositeFlow(java.lang.Long compositeFlowId)

Returns the CompositeBusinessFlow class instance in the registry cache for the specified compositeFlowId. If the cache is disabled then the FlowAccessBean is used to create the CompositeBusinessFlow object. Throws javax.ejb.ObjectNotFoundException if the specified compositeFlowId does not exist.

Parameters:

compositeFlowId - The long CompositeBusinessFlow unique Id number.

Returns:

The CompositeBusinessFlow class object for the specified compositeFlowId.

See Also:

CompositeBusinessFlow

getCompositeFlows

public CompositeBusinessFlow[] getCompositeFlows()

Returns all of the CompositeBusinessFlow objects in the registry cache. If the cache is disabled then the FlowComposeAccessBean is used to create the CompositeBusinessFlow objects. Returns null if no CompositeBusinessFlow objects exist.

Returns:

an array of CompositeBusinessFlow objects, null if no CompositeBusinessFlow objects exist.

See Also:

CompositeBusinessFlow

getDomain

public BusinessFlowDomain getDomain(java.lang.Long businessFlowDomainId)

Returns the BusinessFlowDomain class instance in the registry cache for the specified businessFlowDomainId. If the cache is disabled then the FlowDomainAccessBean is used to create the BusinessFlowDomain object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowDomainId does not exist.

Parameters:

businessFlowDomainId - The long BusinessFlowDomain unique Id number.

Returns:

the BusinessFlowDomain class object for the specified businessFlowDomainId.

See Also:

BusinessFlowDomain

getDomains

public BusinessFlowDomain[] getDomains()

Returns all of the BusinessFlowDomain objects in the registry cache. If the cache is disabled then the FlowDomainAccessBean is used to create the BusinessFlowDomain objects. Returns null if no BusinessFlowDomain objects exist.

Returns:

An array of BusinessFlowDomain objects, null if no BusinessFlowDomain objects exist.

See Also:

BusinessFlowDomain

getFlow

public BusinessFlow getFlow(java.lang.Long businessFlowId)

Returns the BusinessFlow class instance in the registry cache for the specified businessFlowId. If the cache is disabled then the FlowAccessBean is used to create the BusinessFlow object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The long BusinessFlow unique Id number.

Returns:

The BusinessFlow class object for the specified businessFlowId.

See Also:

BusinessFlow

getFlowByFlowTypeIdentifierAndFlowIdentifier

public BusinessFlow getFlowByFlowTypeIdentifierAndFlowIdentifier(java.lang.String aBusinessFlowTypeIdentifier,
                                                                 java.lang.String aFlowIdentifer)

Returns a BusinessFlow object in the registry cache for the specified businessFlowTypeIdentifier and businessFlowIdentifier. If the cache is disabled then the FlowAccessBean is used to create the BusinessFlow object. Returns null if no BusinessFlow exist the specified businessFlowTypeIdentifier and businessFlowIdentifier. Throws javax.ejb.ObjectNotFoundException if the specified businessFlow does not exist.

Parameters:

businessFlowTypeIdentifier - The BusinessFlowType unique identifier.

businessFlowentifier - The long BusinessFlow identifier.

Returns:

A BusinessFlow object for the specified businessFlowTypeIdentifier and businessFlowIdentifier.

See Also:

BusinessFlow, BusinessFlowType

getFlows

public BusinessFlow[] getFlows()

Returns all of the BusinessFlow objects in the registry cache. If the cache is disabled then the FlowAccessBean is used to create the BusinessFlow objects. Returns null if no BusinessFlow objects exist.

Returns:

An array of BusinessFlow objects, null if no BusinessFlow objects exist.

See Also:

BusinessFlow

getFlowsByCompositeFlowId

public BusinessFlow[] getFlowsByCompositeFlowId(java.lang.Long compositeFlowId)

Returns all of the BusinessFlow objects in the registry cache for the specified compositeFlowId. If the cache is disabled then the FlowAccessBean is used to create the BusinessFlow objects. Returns null if no BusinessFlows exist for the specified compositeFlowId. Throws javax.ejb.ObjectNotFoundException if the specified compositeFlowId does not exist.

Parameters:

compositeFlowId - The long CompositeBusinessFlow unique Id number.

Returns:

An array of BusinessFlow objects for the specified compositeFlowId.

See Also:

BusinessFlow, CompositeBusinessFlow

getFlowsByFlowTypeId

public BusinessFlow[] getFlowsByFlowTypeId(java.lang.Long businessFlowTypeId)

Returns all of the BusinessFlow objects in the registry cache for the specified businessFlowTypeId. If the cache is disabled then the FlowAccessBean is used to create the BusinessFlow objects. Returns null if no BusinessFlows exist for the specified businessFlowTypeId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId does not exist.

Parameters:

businessFlowTypeId - The long BusinessFlowType unique Id number.

Returns:

An array of BusinessFlow objects for the specified businessFlowTypeId value

See Also:

BusinessFlow, BusinessFlowType

getFlowStateRelationByFlowIdAndStateId

public BusinessFlowStateRelation getFlowStateRelationByFlowIdAndStateId(java.lang.Long businessFlowId,
                                                                        java.lang.Long businessFlowStateId)

Returns the BusinessFlowStateRelation class instance in the registry cache for the specified businessFlowId and the businessFlowStateId. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowStateRelation object. Throws javax.ejb.ObjectNotFoundException if the BusinessFlowStateRelation does not exist.

Parameters:

businessFlowId - The long BusinessFlow unique Id number.

businessFlowStateId - The long BusinessFlowState unique Id number.

Returns:

The BusinessFlowStateRelation class object for the specified businessFlowId and businessFlowStateId.

See Also:

BusinessFlowStateRelation

getFlowStateRelations

public BusinessFlowStateRelation[] getFlowStateRelations()

Returns all of the BusinessFlowStateRelation objects in the registry cache. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowStateRelation objects. Returns null if no BusinessFlowStateRelation objects exist.

Returns:

An array of BusinessFlowStateRelation objects, null if no BusinessFlowStateRelation objects exist.

See Also:

BusinessFlowStateRelation

getFlowStateRelationsByFlowId

public BusinessFlowStateRelation[] getFlowStateRelationsByFlowId(java.lang.Long businessFlowId)

Returns all the BusinessFlowStateRelation objects in the registry cache for the specified businessFlowId. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowStateRelation objects. Returns null if no BusinessFlowStateRelation objects exist for the specified businessFlowId. Throws javax.ejb.ObjectNotFoundException if the businessFlowId does not exist.

Parameters:

businessFlowId - The long BusinessFlow unique Id number

Returns:

An array of BusinessFlowStateRelation objects for the specified businessFlowId, null if no BusinessFlowStateRelation objects exist for the specified businessFlowId.

See Also:

BusinessFlowStateRelation

getFlowStateRelationsByStateId

public BusinessFlowStateRelation[] getFlowStateRelationsByStateId(java.lang.Long businessFlowStateId)

Returns all the BusinessFlowStateRelation objects in the registry cache for the specified businessFlowStateId. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowStateRelation objects. Returns null if no BusinessFlowStateRelation objects exist for the specified businessFlowStateId. Throws javax.ejb.ObjectNotFoundException if the businessFlowStateId does not exist.

Parameters:

businessFlowStateId - The long BusinessFlowState unique Id number.

Returns:

An array of BusinessFlowStateRelation objects for the specified businessFlowStateId, null if no BusinessFlowStateRelation objects exist for the specified businessFlowStateId.

See Also:

BusinessFlowStateRelation

getFlowType

public BusinessFlowType getFlowType(java.lang.Long businessFlowTypeId)

Returns the BusinessFlowType class instance in the registry cache for the specified businessFlowTypeId. If the cache is disabled then the FlowTypeAccessBean is used to create the BusinessFlowType object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId does not exist.

Parameters:

businessFlowTypeId - The long BusinessFlowType unique Id number.

Returns:

The BusinessFlowType class object for the specified businessFlowTypeId.

See Also:

BusinessFlowType

getFlowTypeByIdentifier

public BusinessFlowType getFlowTypeByIdentifier(java.lang.String flowTypeIdentifier)

Returns the BusinessFlowType class instance in the registry cache for the specified flowTypeIdentifier. If the cache is disabled then the FlowTypeAccessBean is used to create the BusinessFlowType object. Throws javax.ejb.ObjectNotFoundException if the specified flowTypeIdentifier does not exist.

Parameters:

flowTypeIdentifier - The BusinessFlowType string identifier.

Returns:

The BusinessFlowType class object for the specified flowTypeIdentifier.

See Also:

BusinessFlowType

getFlowTypes

public BusinessFlowType[] getFlowTypes()

Returns all of the BusinessFlowType objects in the registry cache. If the cache is disabled then the FlowTypeAccessBean is used to create the BusinessFlowType objects. Returns null if no BusinessFlowType objects exist.

Returns:

An array of BusinessFlowType objects, null if no BusinessFlowType objects exist.

See Also:

BusinessFlowType

getFlowTypesByDomainId

public BusinessFlowType[] getFlowTypesByDomainId(java.lang.Long businessFlowDomainId)

Returns all of the BusinessFlowType objects in the registry cache for the specified businessFlowDomainId. If the cache is disabled then the FlowTypeAccessBean is used to create the BusinessFlowType objects. Returns null if no BusinessFlowType objects exist for the specified businessFlowDomainId. Throws javax.ejb.ObjectNotFoundException if the businessFlowDomainId does not exist.

Returns:

An array of BusinessFlowType objects for the specified businessFlowDomainId, null if no BusinessFlowType objects exist for the specified businessFlowDomainId.

See Also:

BusinessFlowType

getInstance

public static BusinessFlowManager getInstance()

A static method to return a single instance of this class.

Returns:

The single instance of this class.

getState

public BusinessFlowState getState(java.lang.Long businessFlowStateId)

Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowStateId. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowStateId does not exist.

Parameters:

businessFlowStateId - The long BusinessFlowState unique Id number.

Returns:

The BusinessFlowState class object for the specified businessFlowStateId.

See Also:

BusinessFlowState

getStateByFlowIdAndStateType

public BusinessFlowState getStateByFlowIdAndStateType(java.lang.Long businessFlowId,
                                                      java.lang.Integer stateType)

Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowId and stateType. Use BusinessFlowState.START_STATE, BusinessFlowState.NORMAL_STATE, or BusinessFlowState.END_STATE for the state type parameter. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowState object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId or the stateType does not exist.

Parameters:

businessFlowId - The long BusinessFlow unique Id number.

stateType - The BusinessFlowState integer type value, use BusinessFlowState.START_STATE, BusinessFlowState.NORMAL_STATE, or BusinessFlowState.END_STATE.

Returns:

The BusinessFlowState class object for the specified businessFlowId and the stateType.

See Also:

BusinessFlowState

getStateByFlowTypeIdAndIdentifier

public BusinessFlowState getStateByFlowTypeIdAndIdentifier(java.lang.Long businessFlowTypeId,
                                                           java.lang.Integer stateIdentifier)

Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowTypeId and stateIndentifier. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId or the stateIdentifier does not exist.

Parameters:

businessFlowTypeId - The long BusinessFlowType unique Id number.

stateIdentifier - The BusinessFlowState integer identifier.

Returns:

the BusinessFlowState object for the specified businessFlowTypeId and the stateIdentifier.

See Also:

BusinessFlowState

getStateByFlowTypeIdAndStateName

public BusinessFlowState getStateByFlowTypeIdAndStateName(java.lang.Long businessFlowTypeId,
                                                          java.lang.String stateName)

Returns the BusinessFlowState class instance in the registry cache for the specified businessFlowTypeId and stateName. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId or the stateName does not exist.

Parameters:

businessFlowTypeId - The BusinessFlowType long unique Id number.

stateName - String The BusinessFlowState string state name.

Returns:

The BusinessFlowState object for the specified businessFlowTypeId and the stateName.

See Also:

BusinessFlowState

getStateGroup

public BusinessFlowStateGroup getStateGroup(java.lang.Long businessFlowStateGroupId)

Returns the BusinessFlowStateGroup class instance in the registry cache for the specified businessFlowStateGroupId. If the cache is disabled then the FlowStateGroupAccessBean is used to create the BusinessFlowStateGroup object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowStateGroupId does not exist.

Parameters:

businessFlowStateGroupId - The BusinessFlowStateGroup long unique Id number.

Returns:

The BusinessFlowStateGroup object for the specified businessFlowStateGroupId.

See Also:

BusinessFlowState

getStateGroupByFlowTypeIdAndIdentifier

public BusinessFlowStateGroup getStateGroupByFlowTypeIdAndIdentifier(java.lang.Long businessFlowTypeId,
                                                                     java.lang.String businessFlowStateGroupIdentifier)

Returns the BusinessFlowStateGroup class instance in the registry cache for the specified businessFlowTypeId and the businessFlowStateGroupIdentifier. If the cache is disabled then the FlowStateGroupAccessBean is used to create the BusinessFlowStateGroup object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId or the businessFlowStateGroupIdentifier does not exist.

Parameters:

businessFlowTypeId - The BusinessFlowType long unique Id number.

businessFlowStateGroupIdentifier - The BusinessFlowStateGroup string identifier.

Returns:

The BusinessFlowStateGroup object for the specified businessFlowTypeId and the businessFlowStateGroupIdentifier

See Also:

BusinessFlowStateGroup

getStateGroups

public BusinessFlowStateGroup[] getStateGroups()

Returns all of the BusinessFlowStateGroup objects in the registry cache. If the cache is disabled then the FlowStateGroupAccessBean is used to create the BusinessFlowStateGroup objects. Returns null if no BusinessFlowStateGroup objects exist.

Returns:

An array of BusinessFlowStateGroup objects, null if no BusinessFlowStateGroup objects exist.

See Also:

BusinessFlowStateGroup

getStates

public BusinessFlowState[] getStates()

Returns all of the BusinessFlowState objects in the registry cache. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState objects. Returns null if no BusinessFlowState objects exist.

Returns:

An array of BusinessFlowState objects, null if no BusinessFlowState objects exist.

See Also:

BusinessFlowState

getStatesByFlowId

public BusinessFlowState[] getStatesByFlowId(java.lang.Long businessFlowId)

Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowId. If the cache is disabled then the FlowStateRelAccessBean is used to create the BusinessFlowState objects. Returns null if no BusinessFlowState objects exist for the specified businessFlowId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number.

Returns:

An array of BusinessFlowState objects for the specified businessFlowId, null if no BusinessFlowState objects exist for the specified businessFlowId.

See Also:

BusinessFlowState

getStatesByFlowTypeId

public BusinessFlowState[] getStatesByFlowTypeId(java.lang.Long businessFlowTypeId)

Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowTypeId. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState objects. Returns null if no BusinessFlowState objects exist for the specified businessFlowTypeId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTypeId does not exist.

Parameters:

businessFlowTypeId - The BusinessFlowType long unique Id number.

Returns:

An array of BusinessFlowState objects for the specified businessFlowTypeId, null if no BusinessFlowState objects exist for the specified businessFlowTypeId.

See Also:

BusinessFlowState

getStatesByStateGroupId

public BusinessFlowState[] getStatesByStateGroupId(java.lang.Long businessFlowStateGroupId)

Returns all of the BusinessFlowState objects in the registry cache for the specified businessFlowStateGroupId. If the cache is disabled then the FlowStateAccessBean is used to create the BusinessFlowState objects. Returns null if no BusinessFlowState objects exist for the specified businessFlowStateGroupId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowStateGroupId does not exist.

Parameters:

businessFlowStateGroupId - The BusinessFlowStateGroup long unique Id number.

Returns:

An array of BusinessFlowState objects for the specified businessFlowStateGroupId, null if no BusinessFlowState objects exist for the specified businessFlowGroupId.

See Also:

BusinessFlowState

getTransition

public BusinessFlowTransition getTransition(java.lang.Long businessFlowTransitionId)

Returns the BusinessFlowTransition class instance in the registry cache for the specified businessFlowTransitionId. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition object. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowTransitionId does not exist.

Parameters:

businessFlowTransitionId - The BusinessFlowTransition long unique Id number

Returns:

The BusinessFlowTransition object for the specified businessFlowTransitionId.

See Also:

BusinessFlowTransition

getTransitionByFlowIdAndSourceStateIdAndEventIdentifierAndTargetStateId

public BusinessFlowTransition getTransitionByFlowIdAndSourceStateIdAndEventIdentifierAndTargetStateId(java.lang.Long flowId,
                                                                                                      java.lang.Long sourceStateId,
                                                                                                      java.lang.String eventIdentifier,
                                                                                                      java.lang.Long targetStateId)

Returns the BusinessFlowTransition object in the registry cache for the specified businessFlowId, sourceStateId, eventIdentifier, and targetStateId. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition object. Throws javax.ejb.ObjectNotFoundException if the BusinessFlowTransition object does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number.

sourceStateId - The long source BusinessFlowState unique Id number.

eventIdentifier - The string event identifier String for the BusinessFlowTransition.

targetStateId - The long target BusinessFlowState unique Id number.

Returns:

An array of BusinessFlowTransition objects for the specified businessFlowId, sourceStateId, eventIdentifier, and targetStateId.

See Also:

BusinessFlowTransition

getTransitions

public BusinessFlowTransition[] getTransitions()

Returns all of the BusinessFlowTransitions objects in the registry cache. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition objects. Returns null if no BusinessFlowTransition objects exist.

Returns:

An array of BusinessFlowTransition objects, null if no BusinessFlowTransition objects exist.

See Also:

BusinessFlowTransition

getTransitionsByFlowId

public BusinessFlowTransition[] getTransitionsByFlowId(java.lang.Long businessFlowId)

Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition objects. Returns null if no BusinessFlowTransition objects exist for specified businessFlowId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number

Returns:

An array of BusinessFlowTransition objects for the specified businessFlowId, null if no BusinessFlowTransition objects exist for specified businessFlowId.

See Also:

BusinessFlowTransition

getTransitionsByFlowIdAndSourceStateId

public BusinessFlowTransition[] getTransitionsByFlowIdAndSourceStateId(java.lang.Long flowId,
                                                                       java.lang.Long sourceStateId)

Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId and sourceStateId. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition objects. Returns null if no BusinessFlowTransition objects exist for specified businessFlowId and the sourceStateId. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number.

sourceStateId - The long source BusinessFlowState unique Id number.

Returns:

An array of BusinessFlowTransition objects for the specified businessFlowId and sourceStateId, null if no BusinessFlowTransition objects exist for specified businessFlowId and the sourceStateId.

See Also:

BusinessFlowTransition

getTransitionsByFlowIdAndSourceStateIdAndApproval

public BusinessFlowTransition[] getTransitionsByFlowIdAndSourceStateIdAndApproval(java.lang.Long flowId,
                                                                                  java.lang.Long sourceStateId,
                                                                                  java.lang.Integer approval)

Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId, sourceStateId, and approval. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition objects. Returns null if no BusinessFlowTransition objects exist for specified businessFlowId, sourceStateId, and approval. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number.

sourceStateId - The long source BusinessFlowState unique Id number.

approval - The integer approval number for the BusinessFlowTransition.

Returns:

An array of BusinessFlowTransition objects for the specified businessFlowId and sourceStateId, null if no BusinessFlowTransition objects exist for specified businessFlowId, sourceStateId, and approval.

See Also:

BusinessFlowTransition

getTransitionsByFlowIdAndSourceStateIdAndEventIdentifier

public BusinessFlowTransition[] getTransitionsByFlowIdAndSourceStateIdAndEventIdentifier(java.lang.Long flowId,
                                                                                         java.lang.Long sourceStateId,
                                                                                         java.lang.String eventIdentifier)

Returns all of the BusinessFlowTransitions objects in the registry cache for the specified businessFlowId, sourceStateId, and eventIdentifier. If the cache is disabled then the TransitionAccessBean is used to create the BusinessFlowTransition objects. Returns null if no BusinessFlowTransition objects exist for specified businessFlowId, sourceStateId, and eventIdentifier. Throws javax.ejb.ObjectNotFoundException if the specified businessFlowId does not exist.

Parameters:

businessFlowId - The BusinessFlow long unique Id number.

sourceStateId - The long source BusinessFlowState unique Id number.

eventIdentifier - The string event identifier String for the BusinessFlowTransition

Returns:

An array of BusinessFlowTransition objects for the specified businessFlowId and sourceStateId, null if no BusinessFlowTransition objects exist for specified businessFlowId, sourceStateId, and eventIdentifier.

See Also:

BusinessFlowTransition

isCacheEnabled

public boolean isCacheEnabled()

Indicates whether the BusinessFlowRegistry cache is on or off.

Returns:

true means the BusinessFlowRegistry is on, false means it is off