Interface | osid.mapping.path.ObstacleSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByPath | ||
Description |
Orders the results by path. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPathSearchOrder | ||
Description |
Tests if a path search order is available. | ||
Return | boolean | true if a path search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathSearchOrder | ||
Description |
Gets a path search order. | ||
Return | osid.mapping.path.PathSearchOrder | the path search order | |
Errors | UNIMPLEMENTED | supportsPathSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsPathSearchOrder()
is true. | |
Method | orderByLength | ||
Description |
Orders the results by the length of the obstacle. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleSearchOrderRecord | ||
Description |
Gets the obstacle search order record corresponding to
the given obstacle record | ||
Parameters | osid.type.Type | obstacleRecordType | an obstacle record type |
Return | osid.mapping.path.records.ObstacleSearchOrderRecord | the obstacle search order record | |
Errors | NULL_ARGUMENT | obstacleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(obstacleRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |