com.wrq.vhi.script.api
Interface ExecuteOperationEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent

public interface ExecuteOperationEvent
extends EntityEvent, HostSessionEvent

Execute operation event information.

See Also:

OperationEventHandler.executeOperation(com.wrq.vhi.script.api.ExecuteOperationEvent)

Method Summary

void	defaultOperation() Executes the operation's command list and waits to arrive at a primary or alternate destination.
OperationMetaData	getOperationMetaData() Gets the metadata for this operation.
java.lang.String	getOperationName() Gets the operation name.
java.lang.String	waitForArrival(int timeout) Waits for the arrival at one of the operation's primary or alternate destinations.

Methods inherited from interface com.wrq.vhi.script.api.EntityEvent

getEntityName, getTabStops

Methods inherited from interface com.wrq.vhi.script.api.ModelEvent

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Methods inherited from interface com.wrq.vhi.script.api.HostSessionEvent

getHostSession

Methods inherited from interface com.wrq.vhi.script.api.ModelEvent

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Method Detail

getOperationName

java.lang.String getOperationName()

Gets the operation name.

Returns:

operation name

getOperationMetaData

OperationMetaData getOperationMetaData()
                                       throws ApptrieveException

Gets the metadata for this operation.

Returns:

the metadata for the operation

Throws:

ApptrieveException - if an error occurs obtaining the metadata

waitForArrival

java.lang.String waitForArrival(int timeout)
                                throws ApptrieveException

Waits for the arrival at one of the operation's primary or alternate destinations. If an error entity is recognized during the course of waiting, an ApptrieveException is thrown.

Parameters:

timeout - the maximum time to wait in seconds

Returns:

the name of the entity recognized

Throws:

ApptrieveException - if the wait times out or an error entity is recognized.

defaultOperation

void defaultOperation()
                      throws ApptrieveException

Executes the operation's command list and waits to arrive at a primary or alternate destination. If an error entity is recognized during the course of waiting, an ApptrieveException is thrown. If an intermediate destination is recognized the appropriate model-defined action is taken and the wait to arrive continues.

Throws:

ApptrieveException - if the operation fails