Interface ConferralSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ConferralSearch
extends OsidSearch

The search interface for governing conferral searches.

Method Summary

Modifier and Type	Method	Description
ConferralSearchRecord	getConferralSearchRecord(Type conferralSearchRecordType)	Gets the conferral search record corresponding to the given conferral search record Type.
void	orderConferralResults(ConferralSearchOrder conferralSearchOrder)	Specify an ordering to the search results.
void	searchAmongConferrals(IdList conferralIds)	Execute this search among the given list of conferrals.

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

searchAmongConferrals

void searchAmongConferrals(IdList conferralIds)

Execute this search among the given list of conferrals.

Parameters:

conferralIds - list of conferrals

Throws:

NullArgumentException - conferralIds is null

Compliance:

mandatory - This method must be implemented.

orderConferralResults

void orderConferralResults(ConferralSearchOrder conferralSearchOrder)

Specify an ordering to the search results.

Parameters:

conferralSearchOrder - conferral search order

Throws:

NullArgumentException - conferralSearchOrder is null

UnsupportedException - conferralSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getConferralSearchRecord

ConferralSearchRecord getConferralSearchRecord(Type conferralSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

conferralSearchRecordType - a conferral search record type

Returns:

the conferral search record

Throws:

NullArgumentException - conferralSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(conferralSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.