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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RequestQuery can be retrieved from this session and distributorped to this Distributor to create a virtual collection of Requests. The requests may be sequenced using the RequestSearchOrder from this session.

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

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

Gets a request query.

Returnosid.provisioning.RequestQuerythe request query
CompliancemandatoryThis method must be implemented.
MethodgetRequestSearchOrder
Description

Gets a request search order.

Returnosid.provisioning.RequestSearchOrderthe request search order
CompliancemandatoryThis method must be implemented.
MethodapplyRequestQuery
Description

Applies a request query to this distributor.

Parametersosid.provisioning.RequestQueryrequestQuerythe request query
ErrorsNULL_ARGUMENT requestQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED requestQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRequestQuery
Description

Gets a request query inspector for this distributor.

Returnosid.provisioning.RequestQueryInspectorthe request query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRequestSequencing
Description

Applies a request search order to this distributor.

Parametersosid.provisioning.RequestSearchOrderrequestSearchOrderthe request search order
ErrorsNULL_ARGUMENT requestSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED requestSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRequestQueryFromInspector
Description

Gets a request query from an inspector.

Parametersosid.provisioning.RequestQueryInspectorrequestQueryInspectora request query inspector
Returnosid.provisioning.RequestQuerythe request query
ErrorsNULL_ARGUMENT requestQueryInspector is null
UNSUPPORTED requestQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.