OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolConstrainerEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes pool constrainer enablers. The data for create and update is provided via the PoolConstrainerEnablerForm.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreatePoolConstrainerEnabler
Description

Tests if this user can create pool constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a PoolConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if PoolConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreatePoolConstrainerEnablerWithRecordTypes
Description

Tests if this user can create a single PoolConstrainerEnabler using the desired record types. While ProvisioningRulesManager.getPoolConstrainerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific PoolConstrainerEnabler. Providing an empty array tests if a PoolConstrainerEnabler can be created with no records.

Parametersosid.type.Type[]poolConstrainerEnablerRecordTypesarray of pool constrainer enabler record types
Returnboolean true if PoolConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT poolConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerFormForCreate
Description

Gets the pool constrainer enabler form for creating new pool constrainer enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]poolConstrainerEnablerRecordTypesarray of pool constrainer enabler record types
Returnosid.provisioning.rules.PoolConstrainerEnablerFormthe pool constrainer enabler form
ErrorsNULL_ARGUMENT poolConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreatePoolConstrainerEnabler
Description

Creates a new PoolConstrainerEnabler.

Parametersosid.provisioning.rules.PoolConstrainerEnablerFormpoolConstrainerEnablerFormthe form for this PoolConstrainerEnabler
Returnosid.provisioning.rules.PoolConstrainerEnablerthe new PoolConstrainerEnabler
ErrorsILLEGAL_STATE poolConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT poolConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolConstrainerEnablerForm did not originate from getPoolconstrainerEnablerForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdatePoolConstrainerEnablers
Description

Tests if this user can update pool constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a PoolConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if PoolConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerFormForUpdate
Description

Gets the pool constrainer enabler form for updating a existing pool constrainer enabler. A new pool constrainer enabler form should be requested for each update transaction.

Parametersosid.id.IdpoolConstrainerEnablerIdthe Id of the PoolConstrainerEnabler
Returnosid.provisioning.rules.PoolConstrainerEnablerFormthe pool constrainer enabler form
ErrorsNOT_FOUND poolConstrainerEnablerId is not found
NULL_ARGUMENT poolConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePoolConstrainerEnabler
Description

Updates an existing pool constrainer enabler.

Parametersosid.provisioning.rules.PoolConstrainerEnablerFormpoolConstrainerEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE poolConstrainerEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolConstrainerEnablerForm did not originate from getPoolconstrainerEnablerForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeletePoolConstrainerEnablers
Description

Tests if this user can delete pool constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a PoolConstrainerEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if PoolConstrainerEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeletePoolConstrainerEnabler
Description

Deletes a PoolConstrainerEnabler.

Parametersosid.id.IdpoolConstrainerEnablerIdthe Id of the PoolConstrainerEnabler to remove
ErrorsNOT_FOUND poolConstrainerEnablerId not found
NULL_ARGUMENT poolConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManagePoolConstrainerEnablerAliases
Description

Tests if this user can manage Id aliases for pool constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if PoolConstrainerEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasPoolConstrainerEnabler
Description

Adds an Id to a PoolConstrainerEnabler for the purpose of creating compatibility. The primary Id of the PoolConstrainerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another pool constrainer enabler. it is reassigned to the given pool constrainer enabler Id.

Parametersosid.id.IdpoolConstrainerEnablerIdthe Id of a PoolConstrainerEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND poolConstrainerEnablerId not found
NULL_ARGUMENT poolConstrainerEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.