OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.SignalEnabler
Implementsosid.OsidEnabler
Used Byosid.mapping.path.rules.SignalEnablerAdminSession
osid.mapping.path.rules.SignalEnablerList
osid.mapping.path.rules.SignalEnablerLookupSession
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.TypesignalEnablerRecordType the type of signal enabler record to retrieve
Returnosid.mapping.path.rules.records.SignalEnablerRecord the signal enabler record
ErrorsNULL_ARGUMENT signalEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(signalEnablerRecordType) is false
Compliancemandatory This method must be implemented.