org.osid.resourcing

Interface JobSearchOrder

All Superinterfaces:

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

public interface JobSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
JobSearchOrderRecord	getJobSearchOrderRecord(Type jobRecordType) Gets the job search order record corresponding to the given job 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

getJobSearchOrderRecord

JobSearchOrderRecord getJobSearchOrderRecord(Type jobRecordType)
                                             throws OperationFailedException

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

Parameters:

jobRecordType - a job record type

Returns:

the job search order record

Throws:

NullArgumentException - jobRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobRecordType) is false

Compliance:

mandatory - This method must be implemented.