Interface FrontOfficeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FrontOfficeSearch
extends OsidSearch

The search interface for governing front office searches.

Method Summary

Modifier and Type	Method	Description
FrontOfficeSearchRecord	getFrontOfficeSearchRecord(Type frontOfficeSearchRecordType)	Gets the front office search record corresponding to the given front office search record Type .This method is used to retrieve an object implementing the requested record.
void	orderFrontOfficeResults(FrontOfficeSearchOrder frontOfficeSearchOrder)	Specify an ordering to the search results.
void	searchAmongFrontOffices(IdList frontOfficeIds)	Execute this search among the given list of frontOffices.

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

searchAmongFrontOffices

void searchAmongFrontOffices(IdList frontOfficeIds)

Execute this search among the given list of frontOffices.

Parameters:

frontOfficeIds - list of frontOffices

Throws:

NullArgumentException - frontOfficeIds is null

Compliance:

mandatory - This method must be implemented.

orderFrontOfficeResults

void orderFrontOfficeResults(FrontOfficeSearchOrder frontOfficeSearchOrder)

Specify an ordering to the search results.

Parameters:

frontOfficeSearchOrder - front office search order

Throws:

NullArgumentException - frontOfficeSearchOrder is null

UnsupportedException - frontOfficeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFrontOfficeSearchRecord

FrontOfficeSearchRecord getFrontOfficeSearchRecord(Type frontOfficeSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

frontOfficeSearchRecordType - a front office search record type

Returns:

the front office search record

Throws:

NullArgumentException - frontOfficeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.