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

This session creates and removes pool processors. The data for create and update is provided via the PoolProcessorForm.

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

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

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

Parametersosid.type.Type[]poolProcessorRecordTypesarray of pool processor record types
Returnboolean true if PoolProcessor creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT poolProcessorRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorFormForCreate
Description

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

Parametersosid.type.Type[]poolProcessorRecordTypesarray of pool processor record types
Returnosid.provisioning.rules.PoolProcessorFormthe pool processor form
ErrorsNULL_ARGUMENT poolProcessorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreatePoolProcessor
Description

Creates a new PoolProcessor.

Parametersosid.provisioning.rules.PoolProcessorFormpoolProcessorFormthe form for this PoolProcessor
Returnosid.provisioning.rules.PoolProcessorthe new PoolProcessor
ErrorsILLEGAL_STATE poolProcessorForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT poolProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED poolProcessorForm did not originate from getPoolProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdatePoolProcessors
Description

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

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

Parametersosid.id.IdpoolProcessorIdthe Id of the PoolProcessor
Returnosid.provisioning.rules.PoolProcessorFormthe pool processor form
ErrorsNOT_FOUND poolProcessorId is not found
NULL_ARGUMENT poolProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePoolProcessor
Description

Updates a existing pool processor.

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

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

Deletes a PoolProcessor.

Parametersosid.id.IdpoolProcessorIdthe Id of the PoolProcessor to remove
ErrorsNOT_FOUND poolProcessorId not found
NULL_ARGUMENT poolProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManagePoolProcessorAliases
Description

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

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

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