public interface DirectionSearch extends OsidSearch
The search interface for governing direction searches.
Modifier and Type | Method and Description |
---|---|
DirectionSearchRecord |
getDirectionSearchRecord(Type directionSearchRecordType)
Gets the direction search record corresponding to the given direction
search record
Type. |
void |
orderDirectionResults(DirectionSearchOrder directionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDirections(IdList directionIds)
Execute this search among the given list of directions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDirections(IdList directionIds)
directionIds
- list of directionsNullArgumentException
- directionIds
is
null
mandatory
- This method must be implemented. void orderDirectionResults(DirectionSearchOrder directionSearchOrder)
directionSearchOrder
- direction search orderNullArgumentException
- directionSearchOrder
is null
UnsupportedException
- directionSearchOrder
is not of this servicemandatory
- This method must be implemented. DirectionSearchRecord getDirectionSearchRecord(Type directionSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an
object implementing the requested record.directionSearchRecordType
- a direction search record typeNullArgumentException
-
directionSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(directionSearchRecordType)
is
false
mandatory
- This method must be implemented.