Interface SubjectSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SubjectSearch
extends OsidSearch

SubjectSearch defines the interface for specifying subject search options.

Method Summary

Modifier and Type	Method	Description
SubjectSearchRecord	getSubjectSearchRecord(Type subjectSearchRecordType)	Gets the subject search record corresponding to the given subject search record Type.
void	orderSubjectResults(SubjectSearchOrder subjectSearchOrder)	Specify an ordering to the search results.
void	searchAmongSubjects(IdList subjectIds)	Execute this search among the given list of subjects.

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

searchAmongSubjects

void searchAmongSubjects(IdList subjectIds)

Execute this search among the given list of subjects.

Parameters:

subjectIds - list of subjects

Throws:

NullArgumentException - subjectIds is null

Compliance:

mandatory - This method must be implemented.

orderSubjectResults

void orderSubjectResults(SubjectSearchOrder subjectSearchOrder)

Specify an ordering to the search results.

Parameters:

subjectSearchOrder - subject search order

Throws:

NullArgumentException - subjectSearchOrder is null

UnsupportedException - subjectSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSubjectSearchRecord

SubjectSearchRecord getSubjectSearchRecord(Type subjectSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

subjectSearchRecordType - a subject search record type

Returns:

the subject search record

Throws:

NullArgumentException - subjectSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.