Interface ObstacleEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ObstacleEnablerSearch
extends OsidSearch

The search interface for governing obstacle enabler searches.

Method Summary

Modifier and Type	Method	Description
ObstacleEnablerSearchRecord	getObstacleEnablerSearchRecord(Type obstacleEnablerSearchRecordType)	Gets the obstacle enabler search record corresponding to the given obstacle enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderObstacleEnablerResults(ObstacleEnablerSearchOrder obstacleEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongObstacleEnablers(IdList mapIds)	Execute this search among the given list of obstacle enablers.

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

searchAmongObstacleEnablers

void searchAmongObstacleEnablers(IdList mapIds)

Execute this search among the given list of obstacle enablers.

Parameters:

mapIds - list of obstacle enablers

Throws:

NullArgumentException - mapIds is null

Compliance:

mandatory - This method must be implemented.

orderObstacleEnablerResults

void orderObstacleEnablerResults(ObstacleEnablerSearchOrder obstacleEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

obstacleEnablerSearchOrder - obstacle enabler search order

Throws:

NullArgumentException - obstacleEnablerSearchOrder is null

UnsupportedException - obstacleEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerSearchRecord

ObstacleEnablerSearchRecord getObstacleEnablerSearchRecord(Type obstacleEnablerSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

obstacleEnablerSearchRecordType - an obstacle enabler search record type

Returns:

the obstacle enabler search record

Throws:

NullArgumentException - obstacleEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.