Interface RelationshipEnablerSearchOrder

All Superinterfaces:

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

public interface RelationshipEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
RelationshipEnablerSearchOrderRecord	getRelationshipEnablerSearchOrderRecord(Type relationshipEnablerRecordType)	Gets the relationship enabler search order record corresponding to the given relationship enabler record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidEnablerSearchOrder

getCyclicEventSearchOrder, getCyclicTimePeriodSearchOrder, getEventSearchOrder, getScheduleSearchOrder, getTimePeriodSearchOrder, orderByCyclicEvent, orderByCyclicTimePeriod, orderByEvent, orderByRequirement, orderBySchedule, orderByTimePeriod, supportsCyclicEventSearchOrder, supportsCyclicTimePeriodSearchOrder, supportsEventSearchOrder, supportsScheduleSearchOrder, supportsTimePeriodSearchOrder

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

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

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Details

getRelationshipEnablerSearchOrderRecord

RelationshipEnablerSearchOrderRecord getRelationshipEnablerSearchOrderRecord(Type relationshipEnablerRecordType)
                                                                      throws OperationFailedException

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

Parameters:

relationshipEnablerRecordType - a relationship enabler record type

Returns:

the relationship enabler search order record

Throws:

NullArgumentException - relationshipEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relationshipEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.