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

This session provides methods for retrieving PoolConstrainerEnablers.

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

Tests if this user can perform PoolConstrainerEnablers 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.
MethoduseComparativePoolConstrainerEnablerView
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.
MethodusePlenaryPoolConstrainerEnablerView
Description

A complete view of the PoolConstrainerEnabler 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 pool 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.
MethoduseActivePoolConstrainerEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusPoolConstrainerEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetPoolConstrainerEnabler
Description

Gets the PoolConstrainerEnabler specified by its Id.

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

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

Parametersosid.id.IdpoolConstrainerEnablerId Id of the PoolConstrainerEnabler
Returnosid.provisioning.rules.PoolConstrainerEnablerthe pool constrainer enabler
ErrorsNOT_FOUND poolConstrainerEnablerId not found
NULL_ARGUMENT poolConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetPoolConstrainerEnablersByIds
Description

Gets a PoolConstrainerEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the pool 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 PoolConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListpoolConstrainerEnablerIdsthe list of Ids to retrieve
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT poolConstrainerEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablersByGenusType
Description

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

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

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

Parametersosid.type.TypepoolConstrainerEnablerGenusTypea pool constrainer enabler genus type
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler list
ErrorsNULL_ARGUMENT poolConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablersByParentGenusType
Description

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

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

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

Parametersosid.type.TypepoolConstrainerEnablerGenusTypea pool constrainer enabler genus type
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler list
ErrorsNULL_ARGUMENT poolConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablersByRecordType
Description

Gets a PoolConstrainerEnablerList containing the given pool constrainer enabler record Type.

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

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

Parametersosid.type.TypepoolConstrainerEnablerRecordTypea pool constrainer enabler record type
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler list
ErrorsNULL_ARGUMENT poolConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablersOnDate
Description

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

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

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler 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.
MethodgetPoolConstrainerEnablersOnDateWithAgent
Description

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

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

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.provisioning.rules.PoolConstrainerEnablerListthe returned PoolConstrainerEnabler 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.
MethodgetPoolConstrainerEnablers
Description

Gets all PoolConstrainerEnablers.

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

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

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