org.osid.billing

Interface CategorySearchOrder

All Superinterfaces:

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

public interface CategorySearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CategorySearchOrderRecord	getCategorySearchOrderRecord(Type categoryRecordType) Gets the category search order record corresponding to the given category record Type.

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

Method Detail

getCategorySearchOrderRecord

CategorySearchOrderRecord getCategorySearchOrderRecord(Type categoryRecordType)
                                                       throws OperationFailedException

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

Parameters:

categoryRecordType - a category record type

Returns:

the category search order record

Throws:

NullArgumentException - categoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(categoryRecordType) is false

Compliance:

mandatory - This method must be implemented.