Package gda.commandqueue

Interface Queue

All Superinterfaces:

gda.observable.IObservable

All Known Subinterfaces:

IFindableQueueProcessor

All Known Implementing Classes:

CommandQueue, FindableProcessorQueue

public interface Queue
extends gda.observable.IObservable

Queue is used to handle a queue of Command objects As well as typical Queue methods such as addToTail, removeHead there are methods to move items around within the Queue referenced by unique CommandIds. Objects that implement QueueListener can register for events on the queue using the addQueueListener method.

Method Summary

Modifier and Type	Method	Description
CommandId	addToTail(Command command)
CommandId	addToTail(CommandProvider provider)
CommandDetails	getCommandDetails(CommandId id)
CommandSummary	getCommandSummary(CommandId id)
CommandId	getRemovedHeadID()
List<QueuedCommandSummary>	getSummaryList()
void	moveToBefore(CommandId id, Collection<CommandId> cmdIds)
void	moveToHead(Collection<CommandId> cmdIds)
void	moveToTail(Collection<CommandId> cmdIds)
Command	remove(CommandId id)
void	remove(Collection<CommandId> cmdIds)
Collection<Command>	removeAll()
Command	removeHead()
void	replace(CommandId id, Command cmd)
void	setCommandDetails(CommandId id, String details)

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Method Details

addToTail

CommandId addToTail(Command command)
             throws Exception

Throws:

Exception

addToTail

CommandId addToTail(CommandProvider provider)
             throws Exception

Throws:

Exception

removeHead

Command removeHead()
            throws Exception

Throws:

Exception

remove

Command remove(CommandId id)
        throws Exception

Throws:

Exception

remove

void remove(Collection<CommandId> cmdIds)
     throws Exception

Throws:

Exception

removeAll

Collection<Command> removeAll()
                       throws Exception

Throws:

Exception

getSummaryList

List<QueuedCommandSummary> getSummaryList()
                                   throws Exception

Throws:

Exception

moveToHead

void moveToHead(Collection<CommandId> cmdIds)
         throws Exception

Throws:

Exception

moveToTail

void moveToTail(Collection<CommandId> cmdIds)
         throws Exception

Throws:

Exception

moveToBefore

void moveToBefore(CommandId id,
 Collection<CommandId> cmdIds)
           throws Exception

Throws:

Exception

replace

void replace(CommandId id,
 Command cmd)
      throws Exception

Throws:

Exception

getCommandDetails

CommandDetails getCommandDetails(CommandId id)
                          throws Exception

Throws:

Exception

setCommandDetails

void setCommandDetails(CommandId id,
 String details)
                throws Exception

Throws:

Exception

getCommandSummary

CommandSummary getCommandSummary(CommandId id)
                          throws Exception

Throws:

Exception

getRemovedHeadID

CommandId getRemovedHeadID()