public interface IntersectionSearch extends OsidSearch
The search interface for governing intersection searches.
Modifier and Type | Method and Description |
---|---|
IntersectionSearchRecord |
getIntersectionSearchRecord(Type intersectionSearchRecordType)
Gets the intersection search record corresponding to the given
intersection search record
Type. |
void |
orderIntersectionResults(IntersectionSearchOrder intersectionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongIntersections(IdList intersectionIds)
Execute this search among the given list of intersections.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongIntersections(IdList intersectionIds)
intersectionIds
- list of intersectionsNullArgumentException
- intersectionIds
is null
mandatory
- This method must be implemented. void orderIntersectionResults(IntersectionSearchOrder intersectionSearchOrder)
intersectionSearchOrder
- intersection search orderNullArgumentException
- intersectionSearchOrder
is null
UnsupportedException
- intersectionSearchOrder
is not of this servicemandatory
- This method must be implemented. IntersectionSearchRecord getIntersectionSearchRecord(Type intersectionSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.intersectionSearchRecordType
- a intersection search record typeNullArgumentException
-
intersectionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(intersectionSearchRecordType)
is
false
mandatory
- This method must be implemented.