Interface | osid.mapping.LocationLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving locations. This lookup session defines several views:
The methods Locations may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
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 | canLookupLocations | ||
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 | useComparativeLocationView | ||
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 | usePlenaryLocationView | ||
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 locations 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 retrievals to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getLocation | ||
Description |
Gets the | ||
Parameters | osid.id.Id | locationId | the Id of the Location to retrieve |
Return | osid.mapping.Location | the returned Location | |
Errors | NOT_FOUND | no Location found with the given Id | |
NULL_ARGUMENT | locationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | locationIds | the list of Ids to retrieve |
Return | osid.mapping.LocationList | the returned Location list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | locationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | locationGenusType | a location genus type |
Return | osid.mapping.LocationList | the returned Location list | |
Errors | NULL_ARGUMENT | locationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | locationGenusType | a location genus type |
Return | osid.mapping.LocationList | the returned Location list | |
Errors | NULL_ARGUMENT | locationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | locationRecordType | a location record type |
Return | osid.mapping.LocationList | the returned Location list | |
Errors | NULL_ARGUMENT | locationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocations | ||
Description |
Gets all | ||
Return | osid.mapping.LocationList | a list of Locations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |