Interface CampusSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CampusSearch
extends OsidSearch

The search interface for governing campus searches.

Method Summary

Modifier and Type	Method	Description
CampusSearchRecord	getCampusSearchRecord(Type campusSearchRecordType)	Gets the campus search record corresponding to the given campus search record Type.
void	orderCampusResults(CampusSearchOrder campussearchOrder)	Specify an ordering to the search results.
void	searchAmongCampuses(IdList campusIds)	Execute this search among the given list of campuses.

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

searchAmongCampuses

void searchAmongCampuses(IdList campusIds)

Execute this search among the given list of campuses.

Parameters:

campusIds - list of campuses

Throws:

NullArgumentException - campusIds is null

Compliance:

mandatory - This method must be implemented.

orderCampusResults

void orderCampusResults(CampusSearchOrder campussearchOrder)

Specify an ordering to the search results.

Parameters:

campussearchOrder - campus search order

Throws:

NullArgumentException - campussearchOrder is null

UnsupportedException - campussearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCampusSearchRecord

CampusSearchRecord getCampusSearchRecord(Type campusSearchRecordType)
                                  throws OperationFailedException

Gets the campus search record corresponding to the given campus search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

campusSearchRecordType - a campus search record type

Returns:

the campus search record

Throws:

NullArgumentException - campussearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(campussearchRecordType) is false

Compliance:

mandatory - This method must be implemented.