Interface PathSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PathSearch
extends OsidSearch

The search interface for governing path searches.

Method Summary

Modifier and Type	Method	Description
PathSearchRecord	getPathSearchRecord(Type pathSearchRecordType)	Gets the path search record corresponding to the given path search record Type.
void	orderPathResults(PathSearchOrder pathSearchOrder)	Specify an ordering to the search results.
void	searchAmongPaths(IdList pathIds)	Execute this search among the given list of paths.

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

searchAmongPaths

void searchAmongPaths(IdList pathIds)

Execute this search among the given list of paths.

Parameters:

pathIds - list of paths

Throws:

NullArgumentException - pathIds is null

Compliance:

mandatory - This method must be implemented.

orderPathResults

void orderPathResults(PathSearchOrder pathSearchOrder)

Specify an ordering to the search results.

Parameters:

pathSearchOrder - path search order

Throws:

NullArgumentException - pathSearchOrder is null

UnsupportedException - pathSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPathSearchRecord

PathSearchRecord getPathSearchRecord(Type pathSearchRecordType)
                              throws OperationFailedException

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

Parameters:

pathSearchRecordType - a path search record type

Returns:

the path search record

Throws:

NullArgumentException - pathSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.