sale
Class UIGate

java.lang.Object
  sale.UIGate

All Implemented Interfaces:

Gate, Serializable

public class UIGate

extends Object

implements Gate

A gate at which a FormSheet and/or a MenuSheet can be displayed. The transition that leaves the gate will depend on the users interaction with the Form- and/or MenuSheet.

Since:

v2.0

Author:

Steffen Zschaler

See Also:

Serialized Form

Field Summary

protected FormSheet	m_fsFormSheet The FormSheet to be displayed.
protected MenuSheet	m_msMenuSheet The MenuSheet to be displayed.

Constructor Summary

UIGate(FormSheet fs, MenuSheet ms)
Create a new UIGate.

Method Summary

Transition	getNextTransition(SaleProcess pOwner, User usr) Returns the next Transition to jump to.
void	setFormSheet(FormSheet fs) Set the FormSheet that is being displayed at this Gate.
void	setMenuSheet(MenuSheet ms) Set the MenuSheet that is being displayed at this gate.
void	setNextTransition(Transition tNext) Set the transition that will leave this gate.

Methods inherited from class java.lang.Object

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

Field Detail

m_fsFormSheet

protected FormSheet m_fsFormSheet

The FormSheet to be displayed.

m_msMenuSheet

protected MenuSheet m_msMenuSheet

The MenuSheet to be displayed.

Constructor Detail

UIGate

public UIGate(FormSheet fs,
              MenuSheet ms)

Create a new UIGate.

Parameters:

fs - the FormSheet to be displayed. Can be null.

ms - the MenuSheet to be displayed. Can be null.

Method Detail

getNextTransition

public Transition getNextTransition(SaleProcess pOwner,
                                    User usr)
                             throws InterruptedException

Returns the next Transition to jump to.

Specified by:

getNextTransition in interface Gate

Parameters:

pOwner - the process that entered the gate and triggered the method.

usr - the user currently active in the process' ProcessContext

Returns:

the Transition to be performed after leaving the gate.

Throws:

InterruptedException - if an interrupt ocurred while at the gate.

Override:

Never

setFormSheet

public void setFormSheet(FormSheet fs)

Set the FormSheet that is being displayed at this Gate.

Parameters:

fs - the new FormSheet

Override:

Never

setMenuSheet

public void setMenuSheet(MenuSheet ms)

Set the MenuSheet that is being displayed at this gate.

Parameters:

ms - the MenuSheet.

Override:

Never

setNextTransition

public void setNextTransition(Transition tNext)

Set the transition that will leave this gate. This will leave the gate at once and enter the Transition. The transition may return to the gate.

Parameters:

tNext - the transition. Must not be null.

Override:

Never