Interface PositionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PositionSearch
extends OsidSearch

The search interface for governing position searches.

Method Summary

Modifier and Type	Method	Description
PositionSearchRecord	getPositionSearchRecord(Type positionSearchRecordType)	Gets the record corresponding to the given position search record Type .
void	orderPositionResults(PositionSearchOrder positionSearchOrder)	Specify an ordering to the search results.
void	searchAmongPositions(IdList positionIds)	Execute this search among the given list of positions.

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

searchAmongPositions

void searchAmongPositions(IdList positionIds)

Execute this search among the given list of positions.

Parameters:

positionIds - list of positions

Throws:

NullArgumentException - positionIds is null

Compliance:

mandatory - This method must be implemented.

orderPositionResults

void orderPositionResults(PositionSearchOrder positionSearchOrder)

Specify an ordering to the search results.

Parameters:

positionSearchOrder - position search order

Throws:

NullArgumentException - positionSearchOrder is null

UnsupportedException - positionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPositionSearchRecord

PositionSearchRecord getPositionSearchRecord(Type positionSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

positionSearchRecordType - a position search record type

Returns:

the position search record

Throws:

NullArgumentException - positionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(positionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.