OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.QueueAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Queues. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Queue, a QueueForm is requested using getQueueFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned QueueForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the QueueForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each QueueForm corresponds to an attempted transaction.

For updates, QueueForms are requested to the Queue Id that is to be updated using getQueueFormForUpdate(). Similarly, the QueueForm has metadata about the data that can be updated and it can perform validation before submitting the update. The QueueForm can only be used once for a successful update and cannot be reused.

The delete operations delete Queues. To unmap a Queue from the current FrontOffice, the QueueFrontOfficeAssignmentSession should be used. These delete operations attempt to remove the Queue itself thus removing it from all known FrontOffice catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueues
Description

Tests if this user can create Queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Queue will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if Queue creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueWithRecordTypes
Description

Tests if this user can create a single Queue using the desired record types. While TrackingManager.getQueueRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Queue. Providing an empty array tests if a Queue can be created with no records.

Parametersosid.type.Type[]queueRecordTypesarray of queue record types
Returnboolean true if Queue creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT queueRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueFormForCreate
Description

Gets the queue form for creating new queues. A new form should be requested for each create transaction.

Parametersosid.type.Type[]queueRecordTypesarray of queue record types
Returnosid.tracking.QueueFormthe queue form
ErrorsNULL_ARGUMENT queueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateQueue
Description

Creates a new Queue.

Parametersosid.tracking.QueueFormqueueFormthe form for this Queue
Returnosid.tracking.Queuethe new Queue
ErrorsILLEGAL_STATE queueForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT queueForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueForm did not originate from getQueueFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateQueues
Description

Tests if this user can update Queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Queue will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if Queue modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueFormForUpdate
Description

Gets the queue form for updating an existing queue. A new queue form should be requested for each update transaction.

Parametersosid.id.IdqueueIdthe Id of the Queue
Returnosid.tracking.QueueFormthe queue form
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueue
Description

Updates an existing queue.

Parametersosid.tracking.QueueFormqueueFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE queueForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT queueForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueForm did not originate from getQueueFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteQueues
Description

Tests if this user can delete Queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Queue will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if Queue deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteQueue
Description

Deletes a Queue.

Parametersosid.id.IdqueueIdthe Id of the Queue to remove
ErrorsNOT_FOUND queueId not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageQueueAliases
Description

Tests if this user can manage Id aliases for Queues. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if Queue aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasQueue
Description

Adds an Id to a Queue for the purpose of creating compatibility. The primary Id of the Queue is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another queue, it is reassigned to the given queue Id.

Parametersosid.id.IdqueueIdthe Id of a Queue
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND queueId not found
NULL_ARGUMENT queueId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.