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

This session provides methods for searching among BrokerProcessor objects. The search query is constructed using the BrokerProcessorQuery.

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include broker processor in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to broker processor in this distributor

broker processor may have a query record indicated by their respective record types. The query record is accessed via the BrokerProcessorQuery.

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

Tests if this user can perform BrokerProcessor 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 not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include broker processor 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.
MethodgetBrokerProcessorQuery
Description

Gets a broker processor query.

Returnosid.provisioning.rules.BrokerProcessorQuerythe broker processor query
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorsByQuery
Description

Gets a list of BrokerProcessors matching the given search.

Parametersosid.provisioning.rules.BrokerProcessorQuerybrokerProcessorQuerythe search query
Returnosid.provisioning.rules.BrokerProcessorListthe returned BrokerProcessorList
ErrorsNULL_ARGUMENT brokerProcessorQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerProcessorQuery is not of this service
CompliancemandatoryThis method must be implemented.