Interface CandidateSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CandidateSearch
extends OsidSearch

The search interface for governing candidate searches.

Method Summary

Modifier and Type	Method	Description
CandidateSearchRecord	getCandidateSearchRecord(Type candidateSearchRecordType)	Gets the candidate search record corresponding to the given candidate search record Type.
void	orderCandidateResults(CandidateSearchOrder candidateSearchOrder)	Specify an ordering to the search results.
void	searchAmongCandidates(IdList candidateIds)	Execute this search among the given list of candidates.

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

searchAmongCandidates

void searchAmongCandidates(IdList candidateIds)

Execute this search among the given list of candidates.

Parameters:

candidateIds - list of candidate Ids

Throws:

NullArgumentException - candidateIds is null

Compliance:

mandatory - This method must be implemented.

orderCandidateResults

void orderCandidateResults(CandidateSearchOrder candidateSearchOrder)

Specify an ordering to the search results.

Parameters:

candidateSearchOrder - candidate search order

Throws:

NullArgumentException - order is null

UnsupportedException - order is not of this service

Compliance:

mandatory - This method must be implemented.

getCandidateSearchRecord

CandidateSearchRecord getCandidateSearchRecord(Type candidateSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

candidateSearchRecordType - a candidate search record type

Returns:

the candidate search record

Throws:

NullArgumentException - candidateSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(candidateSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.