com.softwareag.mobile.runtime.toolkit.operations.queue

Interface IOperationQueue

All Known Implementing Classes:

BasicOperationQueue, ConditionalOperationQueue

public interface IOperationQueue

Provides a way to execute a set of IOperations in a specific way.
Clients can register any number of IOperationDelegates to get notifications of the execution of each IOperation. Furthermore IOperationQueueDelegate can be registered to get notifications about the queue itself.

Version:

10.1.0.0000-0462

Method Summary

Modifier and Type	Method and Description
void	addDelegate(IOperationDelegate delegate) add a IOperationDelegate that will be notified of events happening with each IOperations in the queue.
void	addDelegate(IOperationQueueDelegate queueDelegate) add a IOperationQueueDelegate that will be notified of events happening with the queue, e.g.
void	addOperation(IOperation o) add the given IOperation to the queue
void	addOperations(java.util.Vector operations) add a bunch of IOperations to the queue
int	getSize()
boolean	isIdle()
void	removeDelegate(IOperationDelegate delegate) remove a IOperationDelegate
void	removeDelegate(IOperationQueueDelegate queueDelegate) remove a IOperationQueueDelegate
void	reset() reset the queue as if it were new, i.e.
void	resume() resume the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in running
void	suspend() halt the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in suspended mode

Method Detail

suspend

void suspend()

halt the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in suspended mode

resume

void resume()

resume the execution of the operations in the queue; the implementation should handle calling this method gracefully when already in running

reset

void reset()

reset the queue as if it were new, i.e. remove all operations

isIdle

boolean isIdle()

Returns:

true if there are no operations in the queue and no operations are currently executed; false otherwise

addOperation

void addOperation(IOperation o)

add the given IOperation to the queue

Parameters:

o - the IOperation to be added

addOperations

void addOperations(java.util.Vector operations)

add a bunch of IOperations to the queue

Parameters:

operations - the IOperations to be added

getSize

int getSize()

Returns:

the number of operations currently in the queue

addDelegate

void addDelegate(IOperationDelegate delegate)

add a IOperationDelegate that will be notified of events happening with each IOperations in the queue. If the same IOperationDelegate is already added, it will not be added again.

Parameters:

delegate - the IOperationDelegate to be added

removeDelegate

void removeDelegate(IOperationDelegate delegate)

remove a IOperationDelegate

Parameters:

delegate - the IOperationDelegate to be removed

addDelegate

void addDelegate(IOperationQueueDelegate queueDelegate)

add a IOperationQueueDelegate that will be notified of events happening with the queue, e.g. when the queue is finished. If the same IOperationQueueDelegate is already added, it will not be added again.

Parameters:

delegate - the IOperationQueueDelegate to be added

removeDelegate

void removeDelegate(IOperationQueueDelegate queueDelegate)

remove a IOperationQueueDelegate

Parameters:

queueDelegate - the IOperationQueueDelegate to be removed