OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.LocationLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving locations.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated map view: All location methods in this session operate, retrieve and pertain to locations defined explicitly in the current map. Using an isolated view is useful for managing Locations with the LocationAdminSession.
  • federated map view: All location lookup methods in this session operate, retrieve and pertain to all locations defined in this map and any other locations implicitly available in this map through map inheritence.

The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

Locations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Locations.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupLocations
Description

Tests if this user can perform Location lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeLocationView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryLocationView
Description

A complete view of the Location returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMapView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.

CompliancemandatoryThis method is must be implemented.
MethodgetLocation
Description

Gets the Location specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Location may have a different Id than requested, such as the case where a duplicate Id was assigned to a Location and retained for compatibility.

Parametersosid.id.IdlocationIdthe Id of the Location to retrieve
Returnosid.mapping.Locationthe returned Location
ErrorsNOT_FOUNDno Location found with the given Id
NULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByIds
Description

Gets a LocationList corresponding to the given IdList. In plenary mode, the returned list contains all of the locations specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Locations may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListlocationIdsthe list of Ids to retrieve
Returnosid.mapping.LocationListthe returned Location list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT locationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByGenusType
Description

Gets a LocationList corresponding to the given location genus Type which does not include locations of types derived from the specified Type. In plenary mode, the returned list contains all known locations or an error results. Otherwise, the returned list may contain only those locations that are accessible through this session.

Parametersosid.type.TypelocationGenusTypea location genus type
Returnosid.mapping.LocationListthe returned Location list
ErrorsNULL_ARGUMENT locationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByParentGenusType
Description

Gets a LocationList corresponding to the given location genus Type and include any additional locations with genus types derived from the specified Type. In plenary mode, the returned list contains all known locations or an error results. Otherwise, the returned list may contain only those locations that are accessible through this session.

Parametersosid.type.TypelocationGenusTypea location genus type
Returnosid.mapping.LocationListthe returned Location list
ErrorsNULL_ARGUMENT locationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByRecordType
Description

Gets a LocationList containing the given location record Type. In plenary mode, the returned list contains all known locations or an error results. Otherwise, the returned list may contain only those locations that are accessible through this session.

Parametersosid.type.TypelocationRecordTypea location record type
Returnosid.mapping.LocationListthe returned Location list
ErrorsNULL_ARGUMENT locationRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocations
Description

Gets all Locations. In plenary mode, the returned list contains all known locations or an error results. Otherwise, the returned list may contain only those locations that are accessible through this session.

Returnosid.mapping.LocationLista list of Locations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.