OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.Map
Implementsosid.OsidCatalog
Description

A Map represents a collection of locations and paths.

MethodgetMapRecord
Description

Gets the map record corresponding to the given Map record Type. This method is used to retrieve an object implementing the requested record. The mapRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(mapRecordType) is true .

Parametersosid.type.TypemapRecordTypethe type of map record to retrieve
Returnosid.mapping.records.MapRecordthe map record
ErrorsNULL_ARGUMENT mapRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mapRecordType) is false
CompliancemandatoryThis method must be implemented.