Interface | osid.mapping.path.IntersectionSearchSession | ||
---|---|---|---|
Implements | osid.mapping.path.IntersectionQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Intersections may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getIntersectionSearch | ||
Description |
Gets an intersection search. | ||
Return | osid.mapping.path.IntersectionSearch | the intersection search | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionSearchOrder | ||
Description |
Gets an intersection search order. The | ||
Return | osid.mapping.path.IntersectionSearchOrder | the intersection search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.mapping.path.IntersectionQuery | intersectionQuery | the intersection query |
osid.mapping.path.IntersectionSearch | intersectionSearch | the intersection search | |
Return | osid.mapping.path.IntersectionSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | intersectionQuery or intersectionSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | intersectionQuery or intersectionSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionQueryFromInspector | ||
Description |
Gets an intersection query from an inspector. The
inspector is available from an | ||
Parameters | osid.mapping.path.IntersectionQueryInspector | intersectionQueryInspector | an intersection query inspector |
Return | osid.mapping.path.IntersectionQuery | the intersection query | |
Errors | NULL_ARGUMENT | intersectionQueryInspector is null | |
UNSUPPORTED | intersectionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |