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

This session creates and removes queue constrainer enablers. The data for create and update is provided via the QueueConstrainerEnablerForm.

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.
MethodcanCreateQueueConstrainerEnabler
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 QueueConstrainerEnabler 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 QueueConstrainerEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateQueueConstrainerEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]queueConstrainerEnablerRecordTypesarray of queue constrainer enabler record types
Returnboolean true if QueueConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT queueConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerFormForCreate
Description

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

Parametersosid.type.Type[]queueConstrainerEnablerRecordTypesarray of queue constrainer enabler record types
Returnosid.tracking.rules.QueueConstrainerEnablerFormthe queue constrainer enabler form
ErrorsNULL_ARGUMENT queueConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateQueueConstrainerEnabler
Description

Creates a new QueueConstrainerEnabler.

Parametersosid.tracking.rules.QueueConstrainerEnablerFormqueueConstrainerEnablerFormthe form for this QueueConstrainerEnabler
Returnosid.tracking.rules.QueueConstrainerEnablerthe new QueueConstrainerEnabler
ErrorsILLEGAL_STATE queueConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT queueConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerEnablerForm did not originate from getQueueConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateQueueConstrainerEnablers
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 QueueConstrainerEnabler 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 QueueConstrainerEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerFormForUpdate
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.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
Returnosid.tracking.rules.QueueConstrainerEnablerFormthe queue constrainer enabler form
ErrorsNOT_FOUND queueConstrainerEnablerId is not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateQueueConstrainerEnabler
Description

Updates an existing queue constrainer enabler.

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

Deletes a QueueConstrainerEnabler.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler to remove
ErrorsNOT_FOUND queueConstrainerEnablerId not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageQueueConstrainerEnablerAliases
Description

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

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

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