Interface OfficeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OfficeSearch
extends OsidSearch

The search interface for governing office searches.

Method Summary

Modifier and Type	Method	Description
OfficeSearchRecord	getOfficeSearchRecord(Type officeSearchRecordType)	Gets the office search record corresponding to the given office search record Type.
void	orderOfficeResults(OfficeSearchOrder officeSearchOrder)	Specify an ordering to the search results.
void	searchAmongOffices(IdList officeIds)	Execute this search among the given list of offices.

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

searchAmongOffices

void searchAmongOffices(IdList officeIds)

Execute this search among the given list of offices.

Parameters:

officeIds - list of offices

Throws:

NullArgumentException - officeIds is null

Compliance:

mandatory - This method must be implemented.

orderOfficeResults

void orderOfficeResults(OfficeSearchOrder officeSearchOrder)

Specify an ordering to the search results.

Parameters:

officeSearchOrder - office search order

Throws:

NullArgumentException - officeSearchOrder is null

UnsupportedException - officeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOfficeSearchRecord

OfficeSearchRecord getOfficeSearchRecord(Type officeSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

officeSearchRecordType - an office search record type

Returns:

the office search record

Throws:

NullArgumentException - officeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(officeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.