Interface | osid.provisioning.rules.PoolProcessorEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes pool processor enablers.
The data for create and update is provided via the | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePoolProcessorEnabler | ||
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 | ||
Return | boolean | false if PoolProcessorEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePoolProcessorEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | poolProcessorEnablerRecordTypes | array of pool processor enabler record types |
Return | boolean | true if PoolProcessorEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | poolProcessorEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolProcessorEnablerFormForCreate | ||
Description |
Gets the pool processor enabler form for creating new pool processor enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | poolProcessorEnablerRecordTypes | array of pool processor enabler record types |
Return | osid.provisioning.rules.PoolProcessorEnablerForm | the pool processor enabler form | |
Errors | NULL_ARGUMENT | poolProcessorEnablerRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createPoolProcessorEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.PoolProcessorEnablerForm | poolProcessorEnablerForm | the form for this PoolProcessorEnabler |
Return | osid.provisioning.rules.PoolProcessorEnabler | the new PoolProcessorEnabler | |
Errors | ILLEGAL_STATE | poolProcessorEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | poolProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | poolProcessorEnablerForm did not originate from
getPoolProcessorEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePoolProcessorEnablers | ||
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 | ||
Return | boolean | false if PoolProcessorEnabler modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolProcessorEnablerFormForUpdate | ||
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. | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of the PoolProcessorEnabler |
Return | osid.provisioning.rules.PoolProcessorEnablerForm | the pool processor enabler form | |
Errors | NOT_FOUND | poolProcessorEnablerId is not found | |
NULL_ARGUMENT | poolProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePoolProcessorEnabler | ||
Description |
Updates an existing pool processor enabler. | ||
Parameters | osid.provisioning.rules.PoolProcessorEnablerForm | poolProcessorEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | poolProcessorEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | poolProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | poolProcessorEnablerForm did not originate from
getPoolProcessorEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePoolProcessorEnablers | ||
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 | ||
Return | boolean | false if PoolProcessorEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePoolProcessorEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of the PoolProcessorEnabler to remove |
Errors | NOT_FOUND | poolProcessorEnablerId not found | |
NULL_ARGUMENT | poolProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePoolProcessorEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if PoolProcessorEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPoolProcessorEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of a PoolProcessorEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | poolProcessorEnablerId not found | ||
NULL_ARGUMENT | poolProcessorEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |