OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.PoolEnabler
Implementsosid.OsidEnabler
Used Byosid.provisioning.rules.PoolEnablerAdminSession
osid.provisioning.rules.PoolEnablerList
osid.provisioning.rules.PoolEnablerLookupSession
Description

A PoolEnabler manages the active status of a Pool.

MethodgetPoolEnablerRecord
Description

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

Parametersosid.type.TypepoolEnablerRecordTypethe type of pool enabler record to retrieve
Returnosid.provisioning.rules.records.PoolEnablerRecordthe pool enabler record
ErrorsNULL_ARGUMENTpoolEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(poolEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.