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

This session provides methods for retrieving BrokerConstrainerEnablers.

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 broker constrainer enabler methods in this session operate, retrieve and pertain to broker constrainer enablers defined explicitly in the current distributor. Using an isolated view is useful for managing BrokerConstrainerEnablers with the BrokerConstrainerEnablerAdminSession.
  • federated distributor view: All broker constrainer enabler methods in this session operate, retrieve and pertain to all broker constrainer enablers defined in this distributor and any other broker constrainer enablers implicitly available in this distributor through distributor inheritence.
  • active broker constrainer enabler view: All broker constrainer enabler lookup methods return active broker constrainer enablers.
  • any status broker constrainer enabler view: Broker 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.
MethodcanLookupBrokerConstrainerEnablers
Description

Tests if this user can perform BrokerConstrainerEnablers 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.
MethoduseComparativeBrokerConstrainerEnablerView
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.
MethodusePlenaryBrokerConstrainerEnablerView
Description

A complete view of the BrokerConstrainerEnabler 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 broker 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.
MethoduseActiveBrokerConstrainerEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusBrokerConstrainerEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetBrokerConstrainerEnabler
Description

Gets the BrokerConstrainerEnabler specified by its Id.

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

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

Parametersosid.id.IdbrokerConstrainerEnablerId Id of the BrokerConstrainerEnabler
Returnosid.provisioning.rules.BrokerConstrainerEnablerthe broker constrainer enabler
ErrorsNOT_FOUND brokerConstrainerEnablerId not found
NULL_ARGUMENT brokerConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBrokerConstrainerEnablersByIds
Description

Gets a BrokerConstrainerEnablerList corresponding to the given IdList.

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

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

Parametersosid.id.IdListbrokerConstrainerEnablerIdsthe list of Ids to retrieve
Returnosid.provisioning.rules.BrokerConstrainerEnablerListthe returned BrokerConstrainerEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT brokerConstrainerEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablersByGenusType
Description

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

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

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

Parametersosid.type.TypebrokerConstrainerEnablerGenusTypea broker constrainer enabler genus type
Returnosid.provisioning.rules.BrokerConstrainerEnablerListthe returned BrokerConstrainerEnabler list
ErrorsNULL_ARGUMENT brokerConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablersByParentGenusType
Description

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

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

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

Parametersosid.type.TypebrokerConstrainerEnablerGenusTypea broker constrainer enabler genus type
Returnosid.provisioning.rules.BrokerConstrainerEnablerListthe returned BrokerConstrainerEnabler list
ErrorsNULL_ARGUMENT brokerConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablersByRecordType
Description

Gets a BrokerConstrainerEnablerList containing the given broker constrainer enabler record Type.

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

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

Parametersosid.type.TypebrokerConstrainerEnablerRecordTypea broker constrainer enabler record type
Returnosid.provisioning.rules.BrokerConstrainerEnablerListthe returned BrokerConstrainerEnabler list
ErrorsNULL_ARGUMENT brokerConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablersOnDate
Description

Gets a BrokerConstrainerEnablerList 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 broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session.

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

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

Gets a BrokerConstrainerEnablerList 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 broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session.

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

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

Gets all BrokerConstrainerEnablers.

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

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

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