Interface | osid.mapping.path.rules.ObstacleEnablerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing obstacle enabler searches. | ||
Method | searchAmongObstacleEnablers | ||
Description |
Execute this search among the given list of obstacle enablers. | ||
Parameters | osid.id.IdList | mapIds | list of obstacle enablers |
Errors | NULL_ARGUMENT | mapIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderObstacleEnablerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.mapping.path.rules.ObstacleEnablerSearchOrder | obstacleEnablerSearchOrder | obstacle enabler search order |
Errors | NULL_ARGUMENT | obstacleEnablerSearchOrder is null | |
UNSUPPORTED | obstacleEnablerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerSearchRecord | ||
Description |
Gets the obstacle enabler search record corresponding
to the given obstacle enabler search record | ||
Parameters | osid.type.Type | obstacleEnablerSearchRecordType | an obstacle enabler search record type |
Return | osid.mapping.path.rules.records.ObstacleEnablerSearchRecord | the obstacle enabler search record | |
Errors | NULL_ARGUMENT | obstacleEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(obstacleEnablerSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |