org.osid.rules.check

Interface AgendaSearchOrder

All Superinterfaces:

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

public interface AgendaSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgendaSearchOrderRecord	getAgendaSearchOrderRecord(Type agendaRecordType) Gets the agenda search order record corresponding to the given agenda 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

getAgendaSearchOrderRecord

AgendaSearchOrderRecord getAgendaSearchOrderRecord(Type agendaRecordType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

agendaRecordType - an agenda record type

Returns:

the agenda search order record

Throws:

NullArgumentException - agendaRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(agendaRecordType) is false

Compliance:

mandatory - This method must be implemented.