Interface CanonicalUnitProcessorEnablerSearchOrder

All Superinterfaces:

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

public interface CanonicalUnitProcessorEnablerSearchOrder
extends OsidEnablerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorEnablerSearchOrderRecord	getCanonicalUnitProcessorEnablerSearchOrderRecord(Type canonicalUnitProcessorEnablerRecordType)	Gets the canonical unit processor enabler search order record corresponding to the given canonical unit processor 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

getCanonicalUnitProcessorEnablerSearchOrderRecord

CanonicalUnitProcessorEnablerSearchOrderRecord getCanonicalUnitProcessorEnablerSearchOrderRecord(Type canonicalUnitProcessorEnablerRecordType)
                                                                                          throws OperationFailedException

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

Parameters:

canonicalUnitProcessorEnablerRecordType - a canonical unit processor enabler record type

Returns:

the canonical unit processor enabler search order record

Throws:

NullArgumentException - canonicalUnitProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.