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

This session provides methods for retrieving Map objects. The Map represents a collection of locations.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Maps it can access, without breaking execution. However, an assessment may only be useful if all Maps referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupMaps
Description

Tests if this user can perform Map 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 opt not to offer lookup operations to unauthorized users.

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

A complete view of the Map 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.
MethodgetMap
Description

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

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.Mapthe map
ErrorsNOT_FOUND mapId not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetMapsByIds
Description

Gets a MapList corresponding to the given IdList. In plenary mode, the returned list contains all of the maps 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 Maps may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListmapIdsthe list of Ids to retrieve
Returnosid.mapping.MapListthe returned Map list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByGenusType
Description

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

Parametersosid.type.TypemapGenusTypea map genus type
Returnosid.mapping.MapListthe returned Map list
ErrorsNULL_ARGUMENT mapGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByParentGenusType
Description

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

Parametersosid.type.TypemapGenusTypea map genus type
Returnosid.mapping.MapListthe returned Map list
ErrorsNULL_ARGUMENT mapGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByRecordType
Description

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

Parametersosid.type.TypemapRecordTypea map record type
Returnosid.mapping.MapListthe returned Map list
ErrorsNULL_ARGUMENT mapRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByProvider
Description

Gets a MapList for the given provider. In plenary mode, the returned list contains all known maps or an error results. Otherwise, the returned list may contain only those maps that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.mapping.MapListthe returned Map list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMaps
Description

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

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