OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.Path
Implementsosid.OsidObject
Description

A Path represents a navigable path or road. The Path is the interface to relate a navigable route to a physical path.

MethodgetPathRecord
Description

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

Parametersosid.type.TypepathRecordTypethe type of path record to retrieve
Returnosid.mapping.path.records.PathRecordthe path record
ErrorsNULL_ARGUMENT pathRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathRecordType) is false
CompliancemandatoryThis method must be implemented.