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

This session creates and removes queue constrainers. The data for create and update is provided via the QueueConstrainerForm.

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 office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueConstrainer
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 QueueConstrainer 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 QueueConstrainer creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueConstrainerWithRecordTypes
Description

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

Parametersosid.type.Type[]queueConstrainerRecordTypesarray of queue constrainer record types
Returnboolean true if QueueConstrainer creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT queueConstrainerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerFormForCreate
Description

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

Parametersosid.type.Type[]queueConstrainerRecordTypesarray of queue constrainer record types
Returnosid.tracking.rules.QueueConstrainerFormthe queue constrainer form
ErrorsNULL_ARGUMENT queueConstrainerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateQueueConstrainer
Description

Creates a new QueueConstrainer.

Parametersosid.tracking.rules.QueueConstrainerFormqueueConstrainerFormthe form for this QueueConstrainer
Returnosid.tracking.rules.QueueConstrainerthe new QueueConstrainer
ErrorsILLEGAL_STATE queueConstrainerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT queueConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerForm did not originate from getQueueConstrainerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateQueueConstrainers
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 QueueConstrainer 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 QueueConstrainer modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerFormForUpdate
Description

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

Parametersosid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer
Returnosid.tracking.rules.QueueConstrainerFormthe queue constrainer form
ErrorsNOT_FOUND queueConstrainerId is not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueueConstrainer
Description

Updates an existing queue constrainer.

Parametersosid.tracking.rules.QueueConstrainerFormqueueConstrainerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE queueConstrainerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT queueConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerForm did not originate from getQueueConstrainerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteQueueConstrainers
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 QueueConstrainer 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 QueueConstrainer deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteQueueConstrainer
Description

Deletes a QueueConstrainer.

Parametersosid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer to remove
ErrorsNOT_FOUND queueConstrainerId not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageQueueConstrainerAliases
Description

Tests if this user can manage Id aliases for queue constrainers. 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 QueueConstrainer aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasQueueConstrainer
Description

Adds a Id to a QueueConstrainer for the purpose of creating compatibility. The primary Id of the QueueConstrainer 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 constrainer. it is reassigned to the given queue constrainer Id.

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