Interface IExecuteOperationEvent

Execute operation event information.

Inherited Members

IEntityEvent.EntityName

IEntityEvent.TabStops

IHostSessionEvent.HostSession

IModelEvent.CurrentOperation

IModelEvent.CurrentProcedure

IModelEvent.ModelContext

IModelEvent.ClientSession

IEvent.Logger

IEvent.CheckForTimeout()

IEvent.EventStack

IEvent.GetHandlerProperty(string)

IEvent.IsDesignEnvironment()

IEvent.CreateUserErrorMessage(string)

IEvent.CreateErrorMessage(int)

IEvent.CreateErrorMessage(int, object[])

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IExecuteOperationEvent : IEntityEvent, IHostSessionEvent, IModelEvent, IEvent

Remarks

Execute operation event information. See ExecuteOperation(IExecuteOperationEvent)

Properties

OperationMetaData

Gets the metadata for this operation.

Declaration

IOperationMetaData OperationMetaData { get; }

Property Value

Type	Description
IOperationMetaData	The metadata for the operation

Exceptions

Type	Condition
ApptrieveException	Throws Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException if an error occurs obtaining the metadata.

OperationName

Gets the operation name.

Declaration

string OperationName { get; }

Property Value

Type	Description
string	The operation name

Methods

DefaultOperation()

Executes the operation's command list and waits to arrive at a primary or alternate destination.

Declaration

void DefaultOperation()

Remarks

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, a Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException is thrown. If an intermediate destination is recognized the appropriate model-defined action is taken and the wait to arrive continues.

Exceptions

Type	Condition
ApptrieveException	Throws Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException if the operation fails

WaitForArrival(int)

Waits for the arrival at one of the operation's primary or alternate destinations.

Declaration

string WaitForArrival(int timeout)

Parameters

Type	Name	Description
int	timeout	The maximum time to wait in seconds

Returns

Type	Description
string	The name of the entity recognized

Remarks

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, a Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException is thrown.

Exceptions

Type	Condition
ApptrieveException	Throws Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException if the wait times out or an error entity is recognized.