org.osid.offering.rules

Interface CanonicalUnitProcessorSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface CanonicalUnitProcessorSearchOrder
extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitProcessorSearchOrderRecord	getCanonicalUnitProcessorSearchOrderRecord(Type canonicalUnitProcessorRecordType) Gets the canonical unit processor search order record corresponding to the given canonical unit processor record Type.

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

Method Detail

getCanonicalUnitProcessorSearchOrderRecord

CanonicalUnitProcessorSearchOrderRecord getCanonicalUnitProcessorSearchOrderRecord(Type canonicalUnitProcessorRecordType)
                                                                                   throws OperationFailedException

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

Parameters:

canonicalUnitProcessorRecordType - a canonical unit processor record type

Returns:

the canonical unit processor search order record

Throws:

NullArgumentException - canonicalUnitProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.