Interface | osid.tracking.QueueResourcingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for resourcing queues. A more detailed assignment service can be managed through the Resourcing OSID. | ||
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 front office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canResourceQueues | ||
Description |
Tests if this user can assign | ||
Return | boolean | false if resource assignment methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canResourceQueue | ||
Description |
Tests if this user can assign | ||
Parameters | osid.id.Id | queueId | the Id of a Queue |
Return | boolean | false if resource assignment methods are not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | queueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getResources | ||
Description |
Gets a list of resource assigned in a queue. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue |
Return | osid.resource.ResourceList | a list of resources | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignResource | ||
Description |
Assigns a | ||
Parameters | osid.id.Id | queueId | the Id of a Queue |
osid.id.Id | resourceId | the Id of the Resource | |
Errors | ALREADY_EXISTS | resourceId already assigned to this queue | |
NOT_FOUND | queueId or resourceId not found | ||
NULL_ARGUMENT | queueId or resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignResource | ||
Description |
Unassigns a | ||
Parameters | osid.id.Id | queueId | the Id of a Queue |
osid.id.Id | resourceId | the Id of the Resource | |
Errors | NOT_FOUND | queueId not found or resourceId not assigned
to this queue | |
NULL_ARGUMENT | queueId or resourceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |