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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BrokerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of Brokers. The brokers may be sequenced using the BrokerSearchOrder from this session.

This Distributor has a default query that matches any broker and a default search order that specifies no sequencing. The queries may be examined using a BrokerQueryInspector. The query may be modified by converting the inspector back to a BrokerQuery.

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

Tests if this user can manage smart distributors. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart distributor management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQuery
Description

Gets a broker query.

Returnosid.provisioning.BrokerQuerythe broker query
CompliancemandatoryThis method must be implemented.
MethodgetBrokerSearchOrder
Description

Gets a broker search order.

Returnosid.provisioning.BrokerSearchOrderthe broker search order
CompliancemandatoryThis method must be implemented.
MethodapplyBrokerQuery
Description

Applies a broker query to this distributor.

Parametersosid.provisioning.BrokerQuerybrokerQuerythe broker query
ErrorsNULL_ARGUMENT brokerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED brokerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBrokerQuery
Description

Gets a broker query inspector for this distributor.

Returnosid.provisioning.BrokerQueryInspectorthe broker query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBrokerSequencing
Description

Applies a broker search order to this distributor.

Parametersosid.provisioning.BrokerSearchOrderbrokerSearchOrderthe broker search order
ErrorsNULL_ARGUMENT brokerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED brokerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQueryFromInspector
Description

Gets a broker query from an inspector.

Parametersosid.provisioning.BrokerQueryInspectorbrokerQueryInspectora broker query inspector
Returnosid.provisioning.BrokerQuerythe broker query
ErrorsNULL_ARGUMENT brokerQueryInspector is null
UNSUPPORTED brokerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.