Interface | osid.provisioning.rules.QueueConstrainerEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes queue constrainer
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 | canCreateQueueConstrainerEnabler | ||
Description |
Tests if this user can create queue constrainer
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 QueueConstrainerEnabler creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQueueConstrainerEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | queueConstrainerEnablerRecordTypes | array of types |
Return | boolean | true if QueueConstrainerEnabler creation
using the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | queueConstrainerEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerFormForCreate | ||
Description |
Gets the queue constrainer enabler form for creating new queue constrainer enablers. A new form should be requested for each create transaction. | ||
Return | osid.provisioning.rules.QueueConstrainerEnablerForm | the queue constrainer enabler form | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | createQueueConstrainerEnabler | ||
Description |
Creates a new | ||
Parameters | osid.provisioning.rules.QueueConstrainerEnablerForm | queueConstrainerEnablerForm | the form for this QueueConstrainerEnabler |
Return | osid.provisioning.rules.QueueConstrainerEnabler | the new QueueConstrainerEnabler | |
Errors | ILLEGAL_STATE | queueConstrainerEnablerForm already used in a create
transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | queueConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerEnablerForm did not originate from
getQueueConstrainerEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQueueConstrainerEnablers | ||
Description |
Tests if this user can update queue constrainer
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 QueueConstrainerEnabler modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerFormForUpdate | ||
Description |
Gets the queue constrainer enabler form for updating an existing queue constrainer enabler. A new queue constrainer enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler |
Return | osid.provisioning.rules.QueueConstrainerEnablerForm | the queue constrainer enabler form | |
Errors | NOT_FOUND | queueConstrainerEnablerId is not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQueueConstrainerEnabler | ||
Description |
Updates an existing queue constrainer enabler. | ||
Parameters | osid.provisioning.rules.QueueConstrainerEnablerForm | queueConstrainerEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | queueConstrainerEnablerForm already used in an update
transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | queueConstrainerEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerEnablerForm did not originate from
getQueueConstrainerEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQueueConstrainerEnablers | ||
Description |
Tests if this user can delete queue constrainer
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 QueueConstrainerEnabler deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueueConstrainerEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler to
remove |
Errors | NOT_FOUND | queueConstrainerEnablerId not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageQueueConstrainerEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if QueueConstrainerEnabler aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasQueueConstrainerEnabler | ||
Description |
Adds a | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of a QueueConstrainerEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | queueConstrainerEnablerId not found | ||
NULL_ARGUMENT | queueConstrainerEnablerId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |