Interface ObstacleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ObstacleSearch
extends OsidSearch

The search interface for governing obstacle searches.

Method Summary

Modifier and Type	Method	Description
ObstacleSearchRecord	getObstacleSearchRecord(Type obstacleSearchRecordType)	Gets the record corresponding to the given obstacle search record Type .
void	orderObstacleResults(ObstacleSearchOrder obstacleSearchOrder)	Specify an ordering to the search results.
void	searchAmongObstacles(IdList obstacleIds)	Execute this search among the given list of obstacle.

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

searchAmongObstacles

void searchAmongObstacles(IdList obstacleIds)

Execute this search among the given list of obstacle.

Parameters:

obstacleIds - list of obstacle

Throws:

NullArgumentException - obstacleIds is null

Compliance:

mandatory - This method must be implemented.

orderObstacleResults

void orderObstacleResults(ObstacleSearchOrder obstacleSearchOrder)

Specify an ordering to the search results.

Parameters:

obstacleSearchOrder - obstacle search order

Throws:

NullArgumentException - obstacleSearchOrder is null

UnsupportedException - obstacleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getObstacleSearchRecord

ObstacleSearchRecord getObstacleSearchRecord(Type obstacleSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

obstacleSearchRecordType - an obstacle search record type

Returns:

the obstacle search record

Throws:

NullArgumentException - obstacleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.