OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueConstrainerEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving QueueConstrainerEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated distributor view: All queue constrainer enabler methods in this session operate, retrieve and pertain to queue constrainer enablers defined explicitly in the current distributor. Using an isolated view is useful for managing QueueConstrainerEnablers with the QueueConstrainerEnablerAdminSession.
  • federated distributor view: All queue constrainer enabler methods in this session operate, retrieve and pertain to all queue constrainer enablers defined in this distributor and any other queue constrainer enablers implicitly available in this distributor through distributor inheritence.
  • active queue constrainer enabler view: All queue constrainer enabler lookup methods return active queue constrainer enablers.
  • any status queue constrainer enabler view: Queue constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupQueueConstrainerEnablers
Description

Tests if this user can perform QueueConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeQueueConstrainerEnablerView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryQueueConstrainerEnablerView
Description

A complete view of the QueueConstrainerEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include queue constrainer enablers in distributors which are children of this distributor in the distributor hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDistributorView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveQueueConstrainerEnablerView
Description

Only active queue constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusQueueConstrainerEnablerView
Description

All active and inactive queue constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerEnabler
Description

Gets the QueueConstrainerEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueConstrainerEnabler and retained for compatibility.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.id.IdqueueConstrainerEnablerId Id of the QueueConstrainerEnabler
Returnosid.provisioning.rules.QueueConstrainerEnablerthe queue constrainer enabler
ErrorsNOT_FOUND queueConstrainerEnablerId not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerEnablersByIds
Description

Gets a QueueConstrainerEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the queue constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.id.IdListqueueConstrainerEnablerIdsthe list of Ids to retrieve
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT queueConstrainerEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByGenusType
Description

Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type which does not include queue constrainer enablers of genus types derived from the specified Type.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.type.TypequeueConstrainerEnablerGenusTypea queue constrainer enabler genus type
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsNULL_ARGUMENT queueConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByParentGenusType
Description

Gets a QueueConstrainerEnablerList corresponding to the given queue constrainer enabler genus Type and include any additional queue constrainer enablers with genus types derived from the specified Type.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.type.TypequeueConstrainerEnablerGenusTypea queue constrainer enabler genus type
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsNULL_ARGUMENT queueConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByRecordType
Description

Gets a QueueConstrainerEnablerList containing the given queue constrainer enabler record Type.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.type.TypequeueConstrainerEnablerRecordTypea queue constrainer enabler record type
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsNULL_ARGUMENT queueConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersOnDate
Description

Gets a QueueConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range for any agent.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active in addition to being active for the given date range. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersOnDateWithAgent
Description

Gets a QueueConstrainerEnablerList effective for the entire the given date range inclusive but not confisned to the date range and evaluated against the given agent.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active in addition to being active for the given date range. In any status mode, active and inactive queue constrainer enablers are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablers
Description

Gets all QueueConstrainerEnablers.

In plenary mode, the returned list contains all known queue constrainer enablers or an error results. Otherwise, the returned list may contain only those queue constrainer enablers that are accessible through this session.

In active mode, queue constrainer enablers are returned that are currently active. In any status mode, active and inactive queue constrainer enablers are returned.

Returnosid.provisioning.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.