org.nuclos.api.context

Interface StateChangeContext

All Superinterfaces:

LogContext, RuleContext

public interface StateChangeContext
extends RuleContext

StateChangeContext represents the context used in StateChange-Rule, StateChange and StateChangeFinal

It contains the TargetState and the SourceState and several functions like caching

Author:

Matthias Reichart

See Also:

RuleContext

Method Summary

Modifier and Type	Method and Description
<T extends Stateful> T	getBusinessObject(java.lang.Class<T> t) This method returns the BusinessObject that State should be changed
<T extends GenericBusinessObject> T	getGenericBusinessObject(java.lang.Class<T> t) This method returns the GenericBusinessObject that State should be changed
State	getSourceState() This method returns the state that has to be changed
UID	getSourceStateId() Deprecated. use method getSourceState()
java.lang.Integer	getSourceStateNumber() Deprecated. use method getSourceState()
State	getTargetState() This method returns the state the user wants to change to
UID	getTargetStateId() Deprecated. use method getTargetState()
java.lang.Integer	getTargetStateNumber() Deprecated. use method getTargetState()
void	notify(java.lang.String message) Creates a message with a Priority.
void	notify(java.lang.String message, Priority prio) Creates a message with a Priority.

Methods inherited from interface org.nuclos.api.context.RuleContext

addContextCacheValue, getContextCacheValue, getLanguage, getUser, removeContextCacheValue

Methods inherited from interface org.nuclos.api.context.LogContext

log, logError, logWarn

Method Detail

getSourceStateId

UID getSourceStateId()

Deprecated. use method getSourceState()

This method returns the state uid that has to be changed

Returns:

State

getSourceState

State getSourceState()

This method returns the state that has to be changed

Returns:

State

getSourceStateNumber

@Deprecated
java.lang.Integer getSourceStateNumber()

Deprecated. use method getSourceState()

This method returns the state number that has to be changed

Returns:

State

getTargetStateId

UID getTargetStateId()

Deprecated. use method getTargetState()

This method returns the state id the user wants to change to

getTargetState

State getTargetState()

This method returns the state the user wants to change to

getTargetStateNumber

@Deprecated
java.lang.Integer getTargetStateNumber()

Deprecated. use method getTargetState()

This method returns the state number the user wants to change to

Returns:

getBusinessObject

<T extends Stateful> T getBusinessObject(java.lang.Class<T> t)

This method returns the BusinessObject that State should be changed

Parameters:

t - Classtype being a Stateful

Returns:

BusinessObject extending Stateful

getGenericBusinessObject

<T extends GenericBusinessObject> T getGenericBusinessObject(java.lang.Class<T> t)
                                                      throws BusinessException

This method returns the GenericBusinessObject that State should be changed

Parameters:

t - Classtype being a GenericBusinessObject

Returns:

GenericBusinessObject extending GenericBusinessObject

Throws:

BusinessException

notify

void notify(java.lang.String message,
            Priority prio)

Creates a message with a Priority. The message is displayed in the notification dialog in nuclos. Please check class Priority to get more information about the priority-handling.

Parameters:

message -

prio -

notify

void notify(java.lang.String message)

Creates a message with a Priority. The message is displayed in the notification dialog in nuclos as a message with priority 'normal'. Please check class Priority to get more information about the priority-handling.

Parameters:

message -