public interface ObstacleSearch extends OsidSearch
The search interface for governing obstacle searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongObstacles(IdList obstacleIds)
obstacleIds
- list of obstacleNullArgumentException
- obstacleIds
is
null
mandatory
- This method must be implemented. void orderObstacleResults(ObstacleSearchOrder obstacleSearchOrder)
obstacleSearchOrder
- obstacle search orderNullArgumentException
- obstacleSearchOrder
is null
UnsupportedException
- obstacleSearchOrder
is not of this servicemandatory
- This method must be implemented. ObstacleSearchRecord getObstacleSearchRecord(Type obstacleSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.obstacleSearchRecordType
- an obstacle search record typeNullArgumentException
- obstacleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleSearchRecordType)
is
false
mandatory
- This method must be implemented.