org.osid.provisioning.rules

Interface QueueProcessorSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface QueueProcessorSearchOrder
extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
QueueProcessorSearchOrderRecord	getQueueProcessorSearchOrderRecord(Type queueProcessorRecordType) Gets the queue processor search order record corresponding to the given queue processor record Type.
void	orderByAutomatic(SearchOrderStyle style) Orders the results by automatic processing.
void	orderByFifo(SearchOrderStyle style) Orders the results by the fifo processing.
void	orderByRemovesProcessedQueueEntries(SearchOrderStyle style) Orders the results by the removal of procesed queue entries.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByAutomatic

void orderByAutomatic(SearchOrderStyle style)

Orders the results by automatic processing.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFifo

void orderByFifo(SearchOrderStyle style)

Orders the results by the fifo processing.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRemovesProcessedQueueEntries

void orderByRemovesProcessedQueueEntries(SearchOrderStyle style)

Orders the results by the removal of procesed queue entries.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchOrderRecord

QueueProcessorSearchOrderRecord getQueueProcessorSearchOrderRecord(Type queueProcessorRecordType)
                                                                   throws OperationFailedException

Gets the queue processor search order record corresponding to the given queue processor record Type. Multiple retrievals return the same underlying object.

Parameters:

queueProcessorRecordType - a queue processor record type

Returns:

the queue processor search order record

Throws:

NullArgumentException - queueProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.