Interface DirectionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DirectionSearch
extends OsidSearch

The search interface for governing direction searches.

Method Summary

Modifier and Type	Method	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.

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

searchAmongDirections

void searchAmongDirections(IdList directionIds)

Execute this search among the given list of directions.

Parameters:

directionIds - list of directions

Throws:

NullArgumentException - directionIds is null

Compliance:

mandatory - This method must be implemented.

orderDirectionResults

void orderDirectionResults(DirectionSearchOrder directionSearchOrder)

Specify an ordering to the search results.

Parameters:

directionSearchOrder - direction search order

Throws:

NullArgumentException - directionSearchOrder is null

UnsupportedException - directionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDirectionSearchRecord

DirectionSearchRecord getDirectionSearchRecord(Type directionSearchRecordType)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

directionSearchRecordType - a direction search record type

Returns:

the direction search record

Throws:

NullArgumentException - directionSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.