org.osid.course.requisite

Interface RequisiteSearchOrder

All Superinterfaces:

Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidEnablerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface RequisiteSearchOrder
extends OsidRuleSearchOrder, OsidEnablerSearchOrder, OsidContainableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RequisiteSearchOrderRecord	getRequisiteSearchOrderRecord(Type requisiteRecordType) Gets the requisite search order record corresponding to the given requisite record Type.

Methods inherited from interface org.osid.OsidEnablerSearchOrder

getCyclicEventSearchOrder, getDemographicSearchOrder, getEventSearchOrder, getScheduleSearchOrder, orderByCyclicEvent, orderByDemographic, orderByEvent, orderBySchedule, supportsCyclicEventSearchOrder, supportsDemographicSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Methods inherited from interface org.osid.OsidContainableSearchOrder

orderBySequestered

Method Detail

getRequisiteSearchOrderRecord

RequisiteSearchOrderRecord getRequisiteSearchOrderRecord(Type requisiteRecordType)
                                                         throws OperationFailedException

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

Parameters:

requisiteRecordType - a requisite record type

Returns:

the requisite search order record

Throws:

NullArgumentException - requisiteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteRecordType) is false

Compliance:

mandatory - This method must be implemented.