OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.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.TypepoolEnablerRecordType the type of pool enabler record to retrieve
Returnosid.provisioning.rules.records.PoolEnablerRecord the pool enabler record
ErrorsNULL_ARGUMENT poolEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(poolEnablerRecordType) is false
Compliancemandatory This method must be implemented.