Interface IntersectionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IntersectionSearch
extends OsidSearch

The search interface for governing intersection searches.

Method Summary

Modifier and Type	Method	Description
IntersectionSearchRecord	getIntersectionSearchRecord(Type intersectionSearchRecordType)	Gets the intersection search record corresponding to the given intersection search record Type .This method is used to retrieve an object implementing the requested record.
void	orderIntersectionResults(IntersectionSearchOrder intersectionSearchOrder)	Specify an ordering to the search results.
void	searchAmongIntersections(IdList intersectionIds)	Execute this search among the given list of intersections.

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

searchAmongIntersections

void searchAmongIntersections(IdList intersectionIds)

Execute this search among the given list of intersections.

Parameters:

intersectionIds - list of intersections

Throws:

NullArgumentException - intersectionIds is null

Compliance:

mandatory - This method must be implemented.

orderIntersectionResults

void orderIntersectionResults(IntersectionSearchOrder intersectionSearchOrder)

Specify an ordering to the search results.

Parameters:

intersectionSearchOrder - intersection search order

Throws:

NullArgumentException - intersectionSearchOrder is null

UnsupportedException - intersectionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIntersectionSearchRecord

IntersectionSearchRecord getIntersectionSearchRecord(Type intersectionSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

intersectionSearchRecordType - a intersection search record type

Returns:

the intersection search record

Throws:

NullArgumentException - intersectionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(intersectionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.