Interface | osid.provisioning.rules.QueueProcessorAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes queue processors. 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 | canCreateQueueProcessor | ||
Description |
Tests if this user can create queue processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if QueueProcessor creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQueueProcessorWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | queueProcessorRecordTypes | array of queue processor record types |
Return | boolean | true if QueueProcessor creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | queueProcessorRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorFormForCreate | ||
Description |
Gets the queue processor form for creating new queue processors. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | queueProcessorRecordTypes | array of queue processor record types |
Return | osid.provisioning.rules.QueueProcessorForm | the queue processor form | |
Errors | NULL_ARGUMENT | queueProcessorRecordTypes 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 | createQueueProcessor | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.QueueProcessorForm | queueProcessorForm | the form for this QueueProcessor |
Return | osid.provisioning.rules.QueueProcessor | the new QueueProcessor | |
Errors | ILLEGAL_STATE | queueProcessorForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | queueProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueProcessorForm did not originate from
getQueueProcessorFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQueueProcessors | ||
Description |
Tests if this user can update queue processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if QueueProcessor modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorFormForUpdate | ||
Description |
Gets the queue processor form for updating an existing queue processor. A new queue processor form should be requested for each update transaction. | ||
Parameters | osid.id.Id | queueProcessorId | the Id of the QueueProcessor |
Return | osid.provisioning.rules.QueueProcessorForm | the queue processor form | |
Errors | NOT_FOUND | queueProcessorId is not found | |
NULL_ARGUMENT | queueProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQueueProcessor | ||
Description |
Updates an existing queue processor. | ||
Parameters | osid.provisioning.rules.QueueProcessorForm | queueProcessorForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | queueProcessorForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | queueProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueProcessorForm did not originate from
getQueueProcessorFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQueueProcessors | ||
Description |
Tests if this user can delete queue processors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if QueueProcessor deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueueProcessor | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | queueProcessorId | the Id of the QueueProcessor to remove |
Errors | NOT_FOUND | queueProcessorId not found | |
NULL_ARGUMENT | queueProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageQueueProcessorAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if QueueProcessor aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasQueueProcessor | ||
Description |
Adds a | ||
Parameters | osid.id.Id | queueProcessorId | the Id of a QueueProcessor |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | queueProcessorId not found | ||
NULL_ARGUMENT | queueProcessorId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |