Interface | osid.tracking.rules.QueueConstrainerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes queue constrainers. The
data for create and update is provided via the | ||
Method | getFrontOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the FrontOffice Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOffice | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOffice | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQueueConstrainer | ||
Description |
Tests if this user can create queue constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if QueueConstrainer creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateQueueConstrainerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | queueConstrainerRecordTypes | array of queue constrainer record types |
Return | boolean | true if QueueConstrainer creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | queueConstrainerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerFormForCreate | ||
Description |
Gets the queue constrainer form for creating new queue constrainers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | queueConstrainerRecordTypes | array of queue constrainer record types |
Return | osid.tracking.rules.QueueConstrainerForm | the queue constrainer form | |
Errors | NULL_ARGUMENT | queueConstrainerRecordTypes 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 | createQueueConstrainer | ||
Description |
Creates a new | ||
Parameters | osid.tracking.rules.QueueConstrainerForm | queueConstrainerForm | the form for this QueueConstrainer |
Return | osid.tracking.rules.QueueConstrainer | the new QueueConstrainer | |
Errors | ILLEGAL_STATE | queueConstrainerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | queueConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerForm did not originate from
getQueueConstrainerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateQueueConstrainers | ||
Description |
Tests if this user can update queue constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if QueueConstrainer modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerFormForUpdate | ||
Description |
Gets the queue constrainer form for updating an existing queue constrainer. A new queue constrainer form should be requested for each update transaction. | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer |
Return | osid.tracking.rules.QueueConstrainerForm | the queue constrainer form | |
Errors | NOT_FOUND | queueConstrainerId is not found | |
NULL_ARGUMENT | queueConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateQueueConstrainer | ||
Description |
Updates an existing queue constrainer. | ||
Parameters | osid.tracking.rules.QueueConstrainerForm | queueConstrainerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | queueConstrainerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | queueConstrainerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueConstrainerForm did not originate from
getQueueConstrainerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteQueueConstrainers | ||
Description |
Tests if this user can delete queue constrainers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if QueueConstrainer deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteQueueConstrainer | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer to remove |
Errors | NOT_FOUND | queueConstrainerId not found | |
NULL_ARGUMENT | queueConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageQueueConstrainerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if QueueConstrainer aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasQueueConstrainer | ||
Description |
Adds a | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | queueConstrainerId not found | ||
NULL_ARGUMENT | queueConstrainerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |