public interface QueueProcessorSearch extends OsidSearch
The search interface for governing queue processor searches.
Modifier and Type | Method and Description |
---|---|
QueueProcessorSearchRecord |
getQueueProcessorSearchRecord(Type queueProcessorSearchRecordType)
Gets the queue processor search record corresponding to the given
queue processor search record
Type. |
void |
orderQueueProcessorResults(QueueProcessorSearchOrder queueProcessorSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongQueueProcessors(IdList frontOfficeIds)
Execute this search among the given list of queue processors.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongQueueProcessors(IdList frontOfficeIds)
frontOfficeIds
- list of queue processorsNullArgumentException
- frontOfficeIds
is null
mandatory
- This method must be implemented. void orderQueueProcessorResults(QueueProcessorSearchOrder queueProcessorSearchOrder)
queueProcessorSearchOrder
- queue processor search orderNullArgumentException
-
queueProcessorSearchOrder
is null
UnsupportedException
- queueProcessorSearchOrder
is not of this servicemandatory
- This method must be implemented. QueueProcessorSearchRecord getQueueProcessorSearchRecord(Type queueProcessorSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.queueProcessorSearchRecordType
- a queue processor search record
typeNullArgumentException
-
queueProcessorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueProcessorSearchRecordType)
is
false
mandatory
- This method must be implemented.