Interface ConvocationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ConvocationSearch
extends OsidSearch

The search interface for governing convocation searches.

Method Summary

Modifier and Type	Method	Description
ConvocationSearchRecord	getConvocationSearchRecord(Type convocationSearchRecordType)	Gets the convocation search record corresponding to the given convocation search record Type .This method is used to retrieve an object implementing the requested record.
void	orderConvocationResults(ConvocationSearchOrder convocationSearchOrder)	Specify an ordering to the search results.
void	searchAmongConvocations(IdList convocationIds)	Execute this search among the given list of convocations.

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

searchAmongConvocations

void searchAmongConvocations(IdList convocationIds)

Execute this search among the given list of convocations.

Parameters:

convocationIds - list of convocations

Throws:

NullArgumentException - convocationIds is null

Compliance:

mandatory - This method must be implemented.

orderConvocationResults

void orderConvocationResults(ConvocationSearchOrder convocationSearchOrder)

Specify an ordering to the search results.

Parameters:

convocationSearchOrder - convocation search order

Throws:

NullArgumentException - convocationSearchOrder is null

UnsupportedException - convocationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getConvocationSearchRecord

ConvocationSearchRecord getConvocationSearchRecord(Type convocationSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

convocationSearchRecordType - a convocation search record type

Returns:

the convocation search record

Throws:

NullArgumentException - convocationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.