com.soasta.scripting.v1

Interface Result

public interface Result

A singleton object that provides access to the Result object for the current play of the current Composition.

See the ScriptEnvironment interface for general background information about this API.

Method Summary

Methods

Modifier and Type	Method and Description
SimulatedActionInfo	createSimulatedActionInfo() Factory method that creates a new instance of a SimulatedActionInfo object.
SimulatedTargetInfo	createSimulatedTargetInfo() Factory method that creates a new instance of a SimulatedTargetInfo object.
SimulatedTransactionInfo	createSimulatedTransactionInfo() Factory method that creates a new instance of a SimulatedTransactionInfo object.
void	postMessage(ResultLevel level, java.lang.String titleText) Inserts a custom event (message) into the Result object with the given text.
void	postMessage(ResultLevel level, java.lang.String titleText, java.lang.String detailsText) Inserts a custom event (message) with details text into the Result object.
void	recordActionCompletion(SimulatedTargetInfo simulatedTargetInfo, SimulatedActionInfo simulatedActionInfo) Records the completion of a simulated Action (Message) into the Result.
void	recordTransactionCompletion(SimulatedTransactionInfo simulatedTransactionInfo) Records the completion of a simulated Transaction that was created by the recordTransactionStart method.
void	recordTransactionStart(SimulatedTransactionInfo simulatedTransactionInfo) Records the start of a simulated Transaction into the Result.

Method Detail

postMessage

void postMessage(ResultLevel level,
               java.lang.String titleText)
                 throws ScriptEnvironmentException

Inserts a custom event (message) into the Result object with the given text. The message event will be recorded for the Script object that has called this Java code.

Parameters:

level - The level of the message (error, info, statistics, verbose).

titleText - The message text.

Throws:

ScriptEnvironmentException

postMessage

void postMessage(ResultLevel level,
               java.lang.String titleText,
               java.lang.String detailsText)
                 throws ScriptEnvironmentException

Inserts a custom event (message) with details text into the Result object. The message event will be recorded for the Script object that has called this Java code.

Parameters:

level - The level of the message (error, info, statistics, verbose).

titleText - The message text (title).

detailsText - The details text, that will be expandable as "details" in the Result Viewer.

Throws:

ScriptEnvironmentException

createSimulatedTargetInfo

SimulatedTargetInfo createSimulatedTargetInfo()

Factory method that creates a new instance of a SimulatedTargetInfo object. These API objects cannot be constructed directly, call this method instead of doing a "new".

Returns:

A new, uninitialized SimulatedTargetInfo object.

createSimulatedActionInfo

SimulatedActionInfo createSimulatedActionInfo()

Factory method that creates a new instance of a SimulatedActionInfo object. These API objects cannot be constructed directly, call this method instead of doing a "new".

Returns:

A new, uninitialized SimulatedActionInfo object.

createSimulatedTransactionInfo

SimulatedTransactionInfo createSimulatedTransactionInfo()

Factory method that creates a new instance of a SimulatedTransactionInfo object. These API objects cannot be constructed directly, call this method instead of doing a "new".

Returns:

A new, uninitialized SimulatedTransactionInfo object.

recordActionCompletion

void recordActionCompletion(SimulatedTargetInfo simulatedTargetInfo,
                          SimulatedActionInfo simulatedActionInfo)
                            throws ScriptEnvironmentException

Records the completion of a simulated Action (Message) into the Result. Typically used when the calling code has implemented some sort of custom Message-like capability. This function allows those actions, and their statistics, to be recorded into the Result as if they were standard Messages.

This method does not actually cause any Message sending or receiving, it is used to record such activity when it is done in some other way other than via a standard Message.

This function has two parameters that describe the simulated Message and it's simulated Target. The simulated Target takes the place of the Target object that a standard Message would have.

It assumed that when this method is called the action has already been completed. (There are not separate "start" and "end" calls.)

Parameters:

simulatedTargetInfo - A SimulatedTargetInfo object that contains information about the simulated Target for the Action. The input object is no longer used or needed once this call returns.

simulatedActionInfo - A SimulatedActionInfo object that contains information about the simulated Action to be recorded. The input object is no longer used or needed once this call returns.

Throws:

ScriptEnvironmentException

recordTransactionStart

void recordTransactionStart(SimulatedTransactionInfo simulatedTransactionInfo)
                            throws ScriptEnvironmentException

Records the start of a simulated Transaction into the Result. It will be recorded into the Result similar to a standard Transaction object that would appear inside of a Clip.

The Transaction will be empty unless simulated actions are recorded inside of it using the recordActionCompletion method, and/or nested Transactions are created inside of it using this method.

Code that is adding simulated actions to the Result can also create Transactions and place the actions inside of those Transactions, to control how things appear and how statistics are computed in the Result.

Parameters:

simulatedTransactionInfo - A SimulatedTransactionInfo object that contains information about the simulated Transaction being started. The input object is no longer used or needed once this call returns.

Throws:

ScriptEnvironmentException

recordTransactionCompletion

void recordTransactionCompletion(SimulatedTransactionInfo simulatedTransactionInfo)
                                 throws ScriptEnvironmentException

Records the completion of a simulated Transaction that was created by the recordTransactionStart method. No more items may be created inside of a Transaction once it has completed.

Parameters:

simulatedTransactionInfo - A SimulatedTransactionInfo object that contains information about the simulated Transaction being completed. The input object is no longer used or needed once this call returns.

Throws:

ScriptEnvironmentException