Interface AgendaSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AgendaSearch
extends OsidSearch

The search interface for governing agenda searches.

Method Summary

Modifier and Type	Method	Description
AgendaSearchRecord	getAgendaSearchRecord(Type agendaSearchRecordType)	Gets the agenda search record corresponding to the given agenda search record Type.
void	orderAgendaResults(AgendaSearchOrder agendaSearchOrder)	Specify an ordering to the search results.
void	searchAmongAgendas(IdList agendaIds)	Execute this search among the given list of agendas.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAgendas

void searchAmongAgendas(IdList agendaIds)

Execute this search among the given list of agendas.

Parameters:

agendaIds - list of agendas

Throws:

NullArgumentException - agendaIds is null

Compliance:

mandatory - This method must be implemented.

orderAgendaResults

void orderAgendaResults(AgendaSearchOrder agendaSearchOrder)

Specify an ordering to the search results.

Parameters:

agendaSearchOrder - agenda search order

Throws:

NullArgumentException - agendaSearchOrder is null

UnsupportedException - agendaSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAgendaSearchRecord

AgendaSearchRecord getAgendaSearchRecord(Type agendaSearchRecordType)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the agenda search record corresponding to the given agenda search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

agendaSearchRecordType - an agenda search record type

Returns:

the agenda search record

Throws:

NullArgumentException - agendaSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(agendaSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.