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

This session provides methods for retrieving Pool objects. The Pool represents a fixed connection between two Provisionables.

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 broker view: All pool methods in this session operate, retrieve and pertain to pools defined explicitly in the current broker. Using an isolated view is useful for managing Pools with the PoolAdminSession.
  • federated broker view: All pool methods in this session operate, retrieve and pertain to all pools defined in this broker and any other pools implicitly available in this broker through broker inheritence.
  • active pool view: active pools are returned from methods in this session
  • any status pool view: active and inactive pools are returned from methods in this session

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 any lookup methods.

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.
MethodcanLookupPools
Description

Tests if this user can perform Pool 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.
MethoduseComparativePoolView
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.
MethodusePlenaryPoolView
Description

A complete view of the Pool 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 pools in distributors which are children of this broker 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.
MethoduseActivePoolView
Description

Only active pools are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusPoolView
Description

Borth active and inactive pools are returned from methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetPool
Description

Gets the Pool specified by its Id.

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

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

Parametersosid.id.IdpoolId Id of the Pool
Returnosid.provisioning.Poolthe pool
ErrorsNOT_FOUND poolId not found
NULL_ARGUMENT poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetPoolsByIds
Description

Gets a PoolList corresponding to the given IdList.

In plenary mode, the returned list contains all of the pools 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 Pools may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListpoolIdsthe list of Ids to retrieve
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT poolIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolsByGenusType
Description

Gets a PoolList corresponding to the given pool genus Type which does not include pools of genus types derived from the specified Type.

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

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

Parametersosid.type.TypepoolGenusTypea pool genus type
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNULL_ARGUMENT poolGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolsByParentGenusType
Description

Gets a PoolList corresponding to the given pool genus Type and include any additional pools with genus types derived from the specified Type.

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

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

Parametersosid.type.TypepoolGenusTypea pool genus type
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNULL_ARGUMENT poolGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolsByRecordType
Description

Gets a PoolList containing the given pool record Type.

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

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

Parametersosid.type.TypepoolRecordTypea pool record type
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNULL_ARGUMENT poolRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolsForBroker
Description

Gets a PoolList by broker .

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

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

Parametersosid.id.IdbrokerIda broker Id
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolsByProvider
Description

Gets a PoolList by provider.

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

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

Parametersosid.id.IdresourceIda resource Id
Returnosid.provisioning.PoolListthe returned Pool list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPools
Description

Gets all Pools.

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

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

Returnosid.provisioning.PoolLista list of Pools
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.