org.trianacode.taskgraph.service

Interface ClipableTaskInterface

All Known Subinterfaces:

RunnableInterface

All Known Implementing Classes:

RunnableTask

public interface ClipableTaskInterface

The interface used by Unit to access RunnableTask. RunnableTasks implement the data handling capability of a Task.

Method Summary

Methods

Modifier and Type	Method and Description
ClipInStore	extractClipInState()
java.lang.Object	getClipIn(java.lang.Object data, java.lang.String name)
java.lang.Object	getClipIn(java.lang.String name)
boolean	isClipInName(java.lang.String name)
void	putClipIn(java.lang.String name, java.lang.Object clipin) Put the specified clip-in in the clip-in bucket
void	queueClipIn(java.lang.String name, java.lang.Object clipin) Queue the specified clip-in to be inserted into the clip-in bucket when the task is next run
java.lang.Object	removeClipIn(java.lang.String name) Remove the clip-in with the specified name from the clip-in bucket
void	restoreClipInState(ClipInStore store) Restores a previously stored clip-in bucket state

Method Detail

getClipIn

java.lang.Object getClipIn(java.lang.String name)

Returns:

the clip-in in the clip-in bucket with the specified name

getClipIn

java.lang.Object getClipIn(java.lang.Object data,
                         java.lang.String name)

Returns:

the clip-in in with the specified name that arrived with the given object. Only the clip-ins of the objects for the current process can be retrieved.

isClipInName

boolean isClipInName(java.lang.String name)

Returns:

true if a clip-in with the specified name exists in the clip-in bucket,

putClipIn

void putClipIn(java.lang.String name,
             java.lang.Object clipin)

Put the specified clip-in in the clip-in bucket

queueClipIn

void queueClipIn(java.lang.String name,
               java.lang.Object clipin)

Queue the specified clip-in to be inserted into the clip-in bucket when the task is next run

removeClipIn

java.lang.Object removeClipIn(java.lang.String name)

Remove the clip-in with the specified name from the clip-in bucket

Returns:

the removed clip-in (or null if unknown)

extractClipInState

ClipInStore extractClipInState()

Returns:

a store of the state of the current clip-in bucket

restoreClipInState

void restoreClipInState(ClipInStore store)

Restores a previously stored clip-in bucket state