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

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

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.
MethodcanCreatePoolProcessorEnabler
Description

Tests if this user can create pool processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a PoolProcessorEnabler 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 PoolProcessorEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreatePoolProcessorEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]poolProcessorEnablerRecordTypesarray of pool processor enabler record types
Returnboolean true if PoolProcessorEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT poolProcessorEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerFormForCreate
Description

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

Parametersosid.type.Type[]poolProcessorEnablerRecordTypesarray of pool processor enabler record types
Returnosid.provisioning.rules.PoolProcessorEnablerFormthe pool processor enabler form
ErrorsNULL_ARGUMENT poolProcessorEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreatePoolProcessorEnabler
Description

Creates a new PoolProcessorEnabler.

Parametersosid.provisioning.rules.PoolProcessorEnablerFormpoolProcessorEnablerFormthe form for this PoolProcessorEnabler
Returnosid.provisioning.rules.PoolProcessorEnablerthe new PoolProcessorEnabler
ErrorsILLEGAL_STATE poolProcessorEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT poolProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolProcessorEnablerForm did not originate from getPoolProcessorEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdatePoolProcessorEnablers
Description

Tests if this user can update pool processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a PoolProcessorEnabler 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 PoolProcessorEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerFormForUpdate
Description

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

Parametersosid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler
Returnosid.provisioning.rules.PoolProcessorEnablerFormthe pool processor enabler form
ErrorsNOT_FOUND poolProcessorEnablerId is not found
NULL_ARGUMENT poolProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePoolProcessorEnabler
Description

Updates an existing pool processor enabler.

Parametersosid.provisioning.rules.PoolProcessorEnablerFormpoolProcessorEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE poolProcessorEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT poolProcessorEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolProcessorEnablerForm did not originate from getPoolProcessorEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeletePoolProcessorEnablers
Description

Tests if this user can delete pool processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a PoolProcessorEnabler 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 PoolProcessorEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeletePoolProcessorEnabler
Description

Deletes a PoolProcessorEnabler.

Parametersosid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler to remove
ErrorsNOT_FOUND poolProcessorEnablerId not found
NULL_ARGUMENT poolProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManagePoolProcessorEnablerAliases
Description

Tests if this user can manage Id aliases for pool processor 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 PoolProcessorEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasPoolProcessorEnabler
Description

Adds an Id to a PoolProcessorEnabler for the purpose of creating compatibility. The primary Id of the PoolProcessorEnabler 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 processor enabler. it is reassigned to the given pool processor enabler Id.

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