Interface | osid.provisioning.rules.QueueProcessorEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes queue 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 | canCreateQueueProcessorEnabler | ||
Description |
Tests if this user can create queue 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 QueueProcessorEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQueueProcessorEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | queueProcessorEnablerRecordTypes | array of types |
Return | boolean | true if QueueProcessorEnabler creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | queueProcessorEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablerFormForCreate | ||
Description |
Gets the queue processor enabler form for creating new queue processor enablers. A new form should be requested for each create transaction. | ||
Return | osid.provisioning.rules.QueueProcessorEnablerForm | the queue processor enabler form | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | createQueueProcessorEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.QueueProcessorEnablerForm | queueProcessorEnablerForm | the form for this QueueProcessorEnabler |
Return | osid.provisioning.rules.QueueProcessorEnabler | the new QueueProcessorEnabler | |
Errors | ILLEGAL_STATE | queueProcessorEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | queueProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueProcessorEnablerForm did not originate from
getQueueProcessorEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQueueProcessorEnablers | ||
Description |
Tests if this user can update queue 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 QueueProcessorEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorEnablerFormForUpdate | ||
Description |
Gets the queue processor enabler form for updating an existing queue processor enabler. A new queue processor enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | queueProcessorEnablerId | the Id of the QueueProcessorEnabler |
Return | osid.provisioning.rules.QueueProcessorEnablerForm | the queue processor enabler form | |
Errors | NOT_FOUND | queueProcessorEnablerId is not found | |
NULL_ARGUMENT | queueProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQueueProcessorEnabler | ||
Description |
Updates an existing queue processor enabler. | ||
Parameters | osid.provisioning.rules.QueueProcessorEnablerForm | queueProcessorEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | queueProcessorEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | queueProcessorEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueProcessorEnablerForm did not originate from
getQueueProcessorEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQueueProcessorEnablers | ||
Description |
Tests if this user can delete queue 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 QueueProcessorEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueueProcessorEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | queueProcessorEnablerId | the Id of the QueueProcessorEnabler to remove |
Errors | NOT_FOUND | queueProcessorEnablerId not found | |
NULL_ARGUMENT | queueProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageQueueProcessorEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if QueueProcessorEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasQueueProcessorEnabler | ||
Description |
Adds a | ||
Parameters | osid.id.Id | queueProcessorEnablerId | the Id of a QueueProcessorEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | queueProcessorEnablerId not found | ||
NULL_ARGUMENT | queueProcessorEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |