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

A SignalEnabler describes the rules for enabling signals.

MethodgetSignalEnablerRecord
Description

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

Parametersosid.type.TypesignalEnablerRecordTypethe type of signal enabler record to retrieve
Returnosid.mapping.path.rules.records.SignalEnablerRecordthe signal enabler record
ErrorsNULL_ARGUMENT signalEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.