Package net.toddm.comm

Interface SubmittableWork

All Known Subinterfaces:

Work

public interface SubmittableWork

An interface implemented by the Comm Framework to publicly express units of work that can be submitted for processing.

Author:

Todd S. Murchison

Method Summary

Modifier and Type	Method	Description
CacheBehavior	getCachingBehavior()	Returns the caching CacheBehavior of this SubmittableWork instance, or null if it had no behavior set.
net.toddm.cache.CachePriority	getCachingPriority()	Returns the caching CachePriority of this SubmittableWork instance, or null if it had no priority set.
int	getId()	Returns the ID of this SubmittableWork instance.
Request	getRequest()	Returns the Request instance associated with this SubmittableWork instance.
Priority	getRequestPriority()	Returns the request Priority of this SubmittableWork instance.
void	setDependentWork(SubmittableWork dependentWork, DependentWorkListener dependentWorkListener)	Causes this SubmittableWork to be dependent on the provided Work.

Method Detail

getId

int getId()

Returns the ID of this SubmittableWork instance. The ID of the underlying Request is used. See Request.getId() for details.

getRequest

Request getRequest()

Returns the Request instance associated with this SubmittableWork instance.

getRequestPriority

Priority getRequestPriority()

Returns the request Priority of this SubmittableWork instance.

getCachingPriority

net.toddm.cache.CachePriority getCachingPriority()

Returns the caching CachePriority of this SubmittableWork instance, or null if it had no priority set.

getCachingBehavior

CacheBehavior getCachingBehavior()

Returns the caching CacheBehavior of this SubmittableWork instance, or null if it had no behavior set.

setDependentWork

void setDependentWork(SubmittableWork dependentWork,
                      DependentWorkListener dependentWorkListener)

Causes this SubmittableWork to be dependent on the provided Work. When processing this Work the CommManager will ensure that the given Work is processed first. This may include pausing the current Work, starting the dependent Work if it has not yet been started, etc.

Parameters:

dependentWork - An instance of SubmittableWork that must finish processing before this instance is processed.

dependentWorkListener - [OPTIONAL] Can be NULL. If provided, this callback is made with the results of the dependent Work before the current work is processed.