org.osid.cataloging.rules

Interface CatalogEnablerSearchOrder

All Superinterfaces:

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

public interface CatalogEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogEnablerSearchOrderRecord	getCatalogEnablerSearchOrderRecord(Type catalogEnablerRecordType) Gets the catalog enabler search order record corresponding to the given catalog enabler 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

Method Detail

getCatalogEnablerSearchOrderRecord

CatalogEnablerSearchOrderRecord getCatalogEnablerSearchOrderRecord(Type catalogEnablerRecordType)
                                                                   throws OperationFailedException

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

Parameters:

catalogEnablerRecordType - a catalog enabler record type

Returns:

the catalog enabler search order record

Throws:

NullArgumentException - catalogEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.