org.osid.checklist

Interface ChecklistSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface ChecklistSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ChecklistSearchOrderRecord	getChecklistSearchOrderRecord(Type checklistRecordType) Gets the checklist search order record corresponding to the given checklist 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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getChecklistSearchOrderRecord

ChecklistSearchOrderRecord getChecklistSearchOrderRecord(Type checklistRecordType)
                                                         throws OperationFailedException

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

Parameters:

checklistRecordType - a checklist record type

Returns:

the checklist search order record

Throws:

NullArgumentException - checklistRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistRecordType) is false

Compliance:

mandatory - This method must be implemented.