ifs.fnd.record

Class FndStateRules

java.lang.Object

ifs.fnd.record.FndStateRules

public final class FndStateRules
extends java.lang.Object

Framework internal class: Holds rules valid on a specific entity state.

This is a framework internal class! Backward compatibility is not guaranteed.

Constructor Summary

Constructors

Constructor and Description
FndStateRules(FndEntityState.Enum state) Create an instance for a named entity state

Method Summary

Modifier and Type	Method and Description
void	add(FndAttributeRule rule) Add a rule on an attribute
void	add(FndRecordRule rule) Add a rule on a record
void	addTransition(FndEntityState.Enum toState) Add a valid transition (target state) for the state owning the rules.
void	addTransition(FndEntityState.Enum toState, FndEntityState.Enum transition) Add a valid transition (target state) for the state owning the rules
void	applyRules(FndAbstractRecord view) Apply all rules on a record.
void	checkTransition(FndEntityState.Enum toState) Check if a state transition is allowed according to the rules.
FndEntityState.Enum	getState() Get the state the rules applies to.
boolean	isRemoveAllowed(FndAbstractRecord view) Checks if removal of a record is allowed.
boolean	isTransitionAllowed(FndEntityState.Enum event) Check if an event is enabled in this state according to the rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

FndStateRules

public FndStateRules(FndEntityState.Enum state)

Create an instance for a named entity state

Parameters:

state - entity state

Method Detail

getState

public FndEntityState.Enum getState()

Get the state the rules applies to.

Returns:

name of the state

addTransition

public void addTransition(FndEntityState.Enum toState)

Add a valid transition (target state) for the state owning the rules. (Self-use! Used from addTransition(toState, transition). That's why this method was made final.)

Parameters:

toState - target state

addTransition

public void addTransition(FndEntityState.Enum toState,
                          FndEntityState.Enum transition)

Add a valid transition (target state) for the state owning the rules

Parameters:

toState - target state

transition - event used to change the state

checkTransition

public void checkTransition(FndEntityState.Enum toState)
                     throws SystemException

Check if a state transition is allowed according to the rules.

Parameters:

toState - target state

Throws:

SystemException - if the target state is not allowed (not in the transitions list)

add

public void add(FndAttributeRule rule)

Add a rule on an attribute

Parameters:

rule - attribute rule

add

public void add(FndRecordRule rule)

Add a rule on a record

Parameters:

rule - record rule

applyRules

public void applyRules(FndAbstractRecord view)

Apply all rules on a record.

Parameters:

view - record to apply the rules on

isRemoveAllowed

public boolean isRemoveAllowed(FndAbstractRecord view)

Checks if removal of a record is allowed.

Parameters:

view - record to check the remove-allowed flag for

Returns:

true if the record may be removed, false otherwise.

isTransitionAllowed

public boolean isTransitionAllowed(FndEntityState.Enum event)

Check if an event is enabled in this state according to the rules.