Interface | osid.mapping.route.RouteLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving premade This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupRoutes | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRouteView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRouteView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include routes in maps which are children of this map in the map hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveRouteView | ||
Description |
Only routes whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveRouteView | ||
Description |
All routes of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRoute | ||
Description |
Gets the In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | routeId | Id of the Route |
Return | osid.mapping.route.Route | the route | |
Errors | NOT_FOUND | routeId not found | |
NULL_ARGUMENT | routeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRoutesByIds | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.IdList | routeIds | the list of Ids to retrieve |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | routeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesByGenusType | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.type.Type | routeGenusType | a route genus type |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | routeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesByParentGenusType | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.type.Type | routeGenusType | a route genus type |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | routeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesByRecordType | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.type.Type | routeRecordType | a route record type |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | routeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known routes or an error results. Otherwise, the returned list may contain only those routes that are accessible through this session. In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForStartingLocation | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | locationId | a location Id |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForStartingLocationOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known routes or an error results. Otherwise, the returned list may contain only those routes that are accessible through this session. In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | locationId | a location Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | locationId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForEndingLocation | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | locationId | a location Id |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | locationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForEndingLocationOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known routes or an error results. Otherwise, the returned list may contain only those routes that are accessible through this session. In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | locationId | a location Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | locationId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForStartingAndEndingLocation | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | startingLocationId | a location Id |
osid.id.Id | endingLocationId | a location Id | |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | startingLocationId or endingLocationId is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesForStartingAndEndingLocationOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known routes or an error results. Otherwise, the returned list may contain only those routes that are accessible through this session. In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.Id | startingLocationId | a location Id |
osid.id.Id | endingLocationId | a location Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | startingLocationId, endingLocationId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesAlongLocations | ||
Description |
Gets a In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Parameters | osid.id.IdList | locationIds | the list of Ids to retrieve |
Return | osid.mapping.route.RouteList | the returned Route list | |
Errors | NULL_ARGUMENT | locationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRoutes | ||
Description |
Gets all In plenary mode, the returned list contains all known routes or an error results. Otherwise, the returned list may contain only those routes that are accessible through this session. In effective mode, routes are returned that are currently effective. In any effective mode, effective routes and those currently expired are returned. | ||
Return | osid.mapping.route.RouteList | a list of Routes | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |