com.soasta.scripting.v1

Interface Composition

public interface Composition

A singleton object that provides access to the current Composition and it's current state.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAborting() Returns an indication as to whether the Composition is currently trying to abort due to a "force stop" request.
boolean	isEnding() Returns an indication as to whether the Composition is currently trying to end early (before normal completion) for any reason, such as a stop request or a fatal error.

Method Detail

isAborting

boolean isAborting()
                   throws ScriptEnvironmentException

Returns an indication as to whether the Composition is currently trying to abort due to a "force stop" request.

Can be checked periodically by code that is doing a time-consuming operation, allowing it to terminate that operation early if it desires to do so

Returns:

True if the Composition is currently trying to abort due to a "force stop" request.

Throws:

ScriptEnvironmentException

isEnding

boolean isEnding()
                 throws ScriptEnvironmentException

Returns an indication as to whether the Composition is currently trying to end early (before normal completion) for any reason, such as a stop request or a fatal error.

Can be checked periodically by code that is doing a time-consuming operation, allowing it to terminate that operation early if it desires to do so

Returns:

True if the Composition is currently trying to end early for any reason.

Throws:

ScriptEnvironmentException