OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.ObstacleEnabler
Implementsosid.OsidEnabler
Description

An ObstacleEnabler describes the rules for enabling an obstacle.

MethodgetObstacleEnablerRecord
Description

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

Parametersosid.type.TypeobstacleEnablerRecordTypethe type of obstacle enabler record to retrieve
Returnosid.mapping.path.rules.records.ObstacleEnablerRecordthe obstacle enabler record
ErrorsNULL_ARGUMENT obstacleEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(obstacleEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.