wt.workflow.engine
Interface WfRequester

All Known Implementing Classes:

ProjectProxy, SummaryActivity, WfAdHocActivity, WfProcessRequester, WfRequesterActivity

public interface WfRequester

WfRequester is an interface for classes that serve as adapters of WfProcess in different usage scenarios. Every WfRequester is associated with a performing process. The main behavior of the requester is to accept events from the performing workflow and relay it to the containing process or calling application.

There are two usage scenarios for the association of a process to a requester:

The first one is the nesting of workflow processes. In this case the WfRequester should be registered as the requester with the implementing sub-process when it is created; upon completion of the sub-process, the WfRequester should enter the completed state.

The second scenario concerns linking a process to another application possibly in another installation. In this case the WfRequester serves as an adapter or proxy for the process.

Supported API: false

Extendable: false

See Also:

WfRequesterActivity, WfProcessRequester

Field Summary

static String

PERFORMER_REF Label for the attribute; Reference to the performer object associated with the requester.

Method Summary

WfExecutionObject	changeState(WfTransition transition) This method is used by containing process of application to force the process to undergo state changes.
WfContainer	getPerformer() Returns the process associated with the requester.
WfContainerReference	getPerformerRef() Gets the value of the attribute: PERFORMER_REF.
void	receiveEvent(Object event) This operation is used by the associated WfProcess to notify its requester of workflow events.
void	setPerformerRef(WfContainerReference a_PerformerRef) Sets the value of the attribute: PERFORMER_REF.

Field Detail

PERFORMER_REF

public static final String PERFORMER_REF

Label for the attribute; Reference to the performer object associated with the requester.

Supported API: false

See Also:

Constant Field Values

Method Detail

getPerformerRef

public WfContainerReference getPerformerRef()

Gets the value of the attribute: PERFORMER_REF. Reference to the performer object associated with the requester.

Supported API: false

Returns:

WfContainerReference

setPerformerRef

public void setPerformerRef(WfContainerReference a_PerformerRef)

Sets the value of the attribute: PERFORMER_REF. Reference to the performer object associated with the requester.

Supported API: false

Parameters:

a_PerformerRef -

receiveEvent

public void receiveEvent(Object event)
                  throws WTException

This operation is used by the associated WfProcess to notify its requester of workflow events. In particular the WfProcess must notify the requester of complete, terminate or abort events or the transition to a closed state.

Supported API: false

Parameters:

event - WfProcess event; contains the source of the event.

Throws:

WTException

changeState

public WfExecutionObject changeState(WfTransition transition)
                              throws WTException

This method is used by containing process of application to force the process to undergo state changes. Returns the updated (and persisted) object. For example, changeState (WfTransition.START) causes the start of the process.

Supported API: false

Parameters:

transition -

Returns:

WfExecutionObject

Throws:

WTException

getPerformer

public WfContainer getPerformer()
                         throws WTException

Returns the process associated with the requester.

Supported API: false

Returns:

WfContainer

Throws:

WTException