org.osid.offering

Interface CanonicalUnitSearchOrder

All Superinterfaces:

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

public interface CanonicalUnitSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitSearchOrderRecord	getCanonicalUnitSearchOrderRecord(Type canonicalUnitRecordType) Gets the canonical unit search order record corresponding to the given canonical unit record Type.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by the code.
void	orderByTitle(SearchOrderStyle style) Specifies a preference for ordering the result set by the title.

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

orderByTitle

void orderByTitle(SearchOrderStyle style)

Specifies a preference for ordering the result set by the title.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCode

void orderByCode(SearchOrderStyle style)

Specifies a preference for ordering the result set by the code.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitSearchOrderRecord

CanonicalUnitSearchOrderRecord getCanonicalUnitSearchOrderRecord(Type canonicalUnitRecordType)
                                                                 throws OperationFailedException

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

Parameters:

canonicalUnitRecordType - a canonical unit record type

Returns:

the canonical unit search order record

Throws:

NullArgumentException - canonicalUnitRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.