org.voltdb.task

Interface ActionResult

public interface ActionResult

The result of executing an Action which was produed by either an IntervalGenerator or ActionScheduler

Method Summary

Modifier and Type	Method and Description
<T> T	getAttachment() Retrieve the attachment associated with this scheduled procedure
long	getInterval(java.util.concurrent.TimeUnit timeUnit) Retrieve the interval after which the action was executed.
java.lang.String	getProcedure()
java.lang.Object[]	getProcedureParameters()
org.voltdb.client.ClientResponse	getResponse()
ActionType	getType()

Method Detail

getType

ActionType getType()

Returns:

The type of action which was performed

getInterval

long getInterval(java.util.concurrent.TimeUnit timeUnit)

Retrieve the interval after which the action was executed.

Parameters:

timeUnit - TimeUnit of interval returned by this method

Returns:

Time interval in timeUnit

getProcedure

java.lang.String getProcedure()

Returns:

Name of procedure that was executed. Will be null if the action was a ActionType.CALLBACK

getProcedureParameters

java.lang.Object[] getProcedureParameters()

Returns:

A The parameters that were passed to the procedure returned by getProcedure()

getResponse

org.voltdb.client.ClientResponse getResponse()

Returns:

ClientResponse from the execution of getProcedure(). Will be null if the action was a ActionType.CALLBACK

getAttachment

<T> T getAttachment()
             throws java.lang.ClassCastException

Retrieve the attachment associated with this scheduled procedure

Type Parameters:

T - Type of attachment

Returns:

The attachment or null of there was no attachment

Throws:

java.lang.ClassCastException - If the attachment is not of type T