org.osid.tracking

Interface QueueSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface QueueSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
QueueSearchOrderRecord	getQueueSearchOrderRecord(Type queueRecordType) Gets the queue search order record corresponding to the given queue record Type.

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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getQueueSearchOrderRecord

QueueSearchOrderRecord getQueueSearchOrderRecord(Type queueRecordType)
                                                 throws OperationFailedException

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

Parameters:

queueRecordType - a queue record type

Returns:

the queue search order record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.