public class SimulatedTransactionInfo
extends java.lang.Object
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.
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 and Description |
---|
SimulatedTransactionInfo() |
public java.lang.String parentPathType
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.
public java.lang.String name
public int repeatIndex
public long startTime
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.
public long deltaFromScheduledStart
This member is used only by the
Result.recordTransactionStart()
method.
public java.lang.String completionType
This member is used only by the
Result.recordTransactionCompletion()
method.
public java.lang.String failureText
This member is used only by the
Result.recordTransactionCompletion()
method.
public long actualDuration
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.
public long effectiveDuration
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.