com.retek.commons.fsm
Class RcomRmmStateModel

java.lang.Object
  extended bycom.retek.fsm.StateModel
      extended bycom.retek.commons.fsm.RcomRmmStateModel
Direct Known Subclasses:
FooStateModel

public class RcomRmmStateModel
extends com.retek.fsm.StateModel

Abstract class for RCOM/RMM state model classes.


Field Summary
 
Fields inherited from class com.retek.fsm.StateModel
DBBUILD_EVENT_DESCRIPTOR_CODE, PARTCHANGED_EVENT_DESCRIPTOR_CODE, START_EVENT_DESCRIPTOR_CODE
 
Constructor Summary
RcomRmmStateModel(com.retek.fsm.StateModelMgr stateModelMgr)
           
 
Method Summary
protected  com.retek.fsm.StateDescriptor buildDecisionStateDescriptor(java.lang.String stateCode, java.lang.String stateDescription, RcomRmmEventDescriptor eventDescriptor, com.retek.fsm.EventTransformer eventTransformer)
          Create a new Decision StateDescriptor object for a given state code and description.
protected  RcomRmmEvent buildEvent(java.lang.String eventDescriptorCode)
          Create a new Event object for a given event descriptor code.
protected  RcomRmmEventDescriptor buildRcomRmmEventDescriptor(java.lang.String eventDescriptorCode, java.lang.Class eventClass)
          Create a new RcomRmmEventDescriptor object for a given event descriptor code and event class.
protected  com.retek.fsm.StateDescriptor buildStateDescriptor(java.lang.String stateCode, java.lang.String stateDescription)
          Create a new StateDescriptor object for a given state code and description.
static com.retek.fsm.State getState(com.retek.fsm.StateModel model, java.lang.String stateCode)
          Return the State object for a given state model and state code.
 boolean inState(RcomRmmFsmable fsmableBo, com.retek.fsm.StateDescriptor stateDescriptor)
          Return boolean indicating if a Fsmable business object is in a specific state.
static void registerStateModel(java.lang.Class fsmableClass, java.lang.Class stateModelClass)
          Register a StateModel object within RCOM.
 
Methods inherited from class com.retek.fsm.StateModel
buildDecisionStateDescriptor, buildEventDescriptor, buildEventDescriptor, buildInternalTransition, buildStateDescriptor, buildTransition, findEventDescriptorForCode, findEventFanout, findEventFanout, findEventFanoutForUI, findStateDescriptorForCode, findStateDescriptorForState, findTransitions, getAllEventDescriptors, getAllNonSuperStates, getAllStateDescriptors, getAllStateTransitions, getDbBuildEventDescriptor, getLocalizer, getPartChangedEventDescriptor, getStartEventDescriptor, getStartState, mapHasTransitions, setLocalizer, setStartState, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RcomRmmStateModel

public RcomRmmStateModel(com.retek.fsm.StateModelMgr stateModelMgr)
Method Detail

registerStateModel

public static void registerStateModel(java.lang.Class fsmableClass,
                                      java.lang.Class stateModelClass)
Register a StateModel object within RCOM.

Parameters:
fsmableClass -
stateModelClass -

getState

public static com.retek.fsm.State getState(com.retek.fsm.StateModel model,
                                           java.lang.String stateCode)
Return the State object for a given state model and state code.

Parameters:
model - state model
stateCode - state code
Returns:
State the state object from the model passed in or null if not found.

inState

public final boolean inState(RcomRmmFsmable fsmableBo,
                             com.retek.fsm.StateDescriptor stateDescriptor)
                      throws SystemException
Return boolean indicating if a Fsmable business object is in a specific state.

Parameters:
fsmableBo - source business object
stateDescriptor - state descriptor
Returns:
true if business object is in the specified state
Throws:
SystemException

buildStateDescriptor

protected final com.retek.fsm.StateDescriptor buildStateDescriptor(java.lang.String stateCode,
                                                                   java.lang.String stateDescription)
Create a new StateDescriptor object for a given state code and description.

Parameters:
stateCode -
stateDescription -
Returns:
StateDescriptor

buildDecisionStateDescriptor

protected final com.retek.fsm.StateDescriptor buildDecisionStateDescriptor(java.lang.String stateCode,
                                                                           java.lang.String stateDescription,
                                                                           RcomRmmEventDescriptor eventDescriptor,
                                                                           com.retek.fsm.EventTransformer eventTransformer)
Create a new Decision StateDescriptor object for a given state code and description.

Parameters:
stateCode - state code identifier
stateDescription - state description
eventDescriptor - event descriptor for the decision
eventTransformer - event transformer for the decision
Returns:
StateDescriptor

buildRcomRmmEventDescriptor

protected final RcomRmmEventDescriptor buildRcomRmmEventDescriptor(java.lang.String eventDescriptorCode,
                                                                   java.lang.Class eventClass)
Create a new RcomRmmEventDescriptor object for a given event descriptor code and event class. This also registers the event with the state model instance.

Parameters:
eventDescriptorCode -
eventClass -
Returns:
RcomRmmEventDescriptor

buildEvent

protected final RcomRmmEvent buildEvent(java.lang.String eventDescriptorCode)
                                 throws SystemException
Create a new Event object for a given event descriptor code.

Parameters:
eventDescriptorCode -
Returns:
RcomRmmEvent new event
Throws:
SystemException


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25