com.soasta.scripting.v1

Class SimulatedTransactionInfo

java.lang.Object

com.soasta.scripting.v1.SimulatedTransactionInfo

public class SimulatedTransactionInfo
extends java.lang.Object

Contains information about a simulated Transaction that is being recorded into the Result via the recordTransactionStart or recordTransactionCompletion method of the Result object.

Note that an instance of this class cannot be constructed directly via "new". Instead, the createSimulatedTransactionInfo factory method must be used.

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

Field Summary

Fields

Modifier and Type	Field and Description
long	actualDuration Optionally, the actual duration of the Transaction in milliseconds.
java.lang.String	completionType The completion type for this Transaction.
long	deltaFromScheduledStart The difference, in milliseconds, between the time this Transaction was "scheduled" to be started and when it was actually started.
long	effectiveDuration Optionally, the "effective" duration of the Transaction in milliseconds.
java.lang.String	failureText If the Transaction is to be considered as having failed, this is the error text for the failure.
java.lang.String	name The name to be assigned to the simulated Transaction.
java.lang.String	parentPath parentPathType and parentPath specify the "starting point" of the path, and the path itself, respectively, to the containing item into which this Transaction is to be recorded.
java.lang.String	parentPathType See parentPath.
int	repeatIndex An optional repeat index if the simulated Transaction is to be considered to be repeating.
long	startTime Optionally, the start time of the Transaction, as expressed by System.currentTimeMillis() (the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.

Constructor Summary

Constructors

Constructor and Description
SimulatedTransactionInfo()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parentPathType

public java.lang.String parentPathType

See parentPath.

parentPath

public java.lang.String parentPath

parentPathType and parentPath specify the "starting point" of the path, and the path itself, respectively, to the containing item into which this Transaction is to be recorded. These are relative to the context in which the current Script is playing, as specified for property paths within "In Situ Substitution Specifications" (ISSEs).

Refer to the separate documentation on ISSEs on CloudLink for more information about pathing.

The parent item specified must be a Clip or a container within a Clip, and must be an item that is currently playing (has started but has not yet completed). Typically this might be either some parent of the current Script, or else another simulated Transaction that was started earlier by calling the Result.recordTransactionStart() method.

If these members are null, the parent of the Script object that called this Java code will be used as the parent.

name

public java.lang.String name

The name to be assigned to the simulated Transaction. This name cannnot be the same as the name of any other object in the parent container.

repeatIndex

public int repeatIndex

An optional repeat index if the simulated Transaction is to be considered to be repeating. Negative means no repeat. The index cannot be the same as any other index given with the same name previously. Gaps within the indexes are permitted.

startTime

public long startTime

Optionally, the start time of the Transaction, as expressed by System.currentTimeMillis() (the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.

If this value is less than zero (the default value), the start time will be assumed to be the time of the call to start the Transaction.

This time cannot be before the start time of the Composition.

This member is used only by the Result.recordTransactionStart() method.

deltaFromScheduledStart

public long deltaFromScheduledStart

The difference, in milliseconds, between the time this Transaction was "scheduled" to be started and when it was actually started. Usually only meant to be used for Timed Clips.

This member is used only by the Result.recordTransactionStart() method.

completionType

public java.lang.String completionType

The completion type for this Transaction. Must be "Success", "Fail", or "Stop".

This member is used only by the Result.recordTransactionCompletion() method.

failureText

public java.lang.String failureText

If the Transaction is to be considered as having failed, this is the error text for the failure. This text is used only if the "completionType" is "Fail".

This member is used only by the Result.recordTransactionCompletion() method.

actualDuration

public long actualDuration

Optionally, the actual duration of the Transaction in milliseconds.

If this value is less than zero (the default value), the duration will be computed by subtracting the current time from the start time.

This member is used only by the Result.recordTransactionCompletion() method.

effectiveDuration

public long effectiveDuration

Optionally, the "effective" duration of the Transaction in milliseconds.

If this value is less than zero (the default value), the "effective" duration will be assumed to be the same as the actual duration.

This member is used only by the Result.recordTransactionCompletion() method.

Constructor Detail

SimulatedTransactionInfo

public SimulatedTransactionInfo()