OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitProcessorQuerySession
Implementsosid.OsidSession
Description

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

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include canonical unit processor in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to canonical unit processor in this catalogue

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

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchCanonicalUnitProcessors
Description

Tests if this user can perform CanonicalUnitProcessor 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.
MethoduseFederatedCatalogueView
Description

Federates the view for methods in this session. A federated view will include canonical unit processor in catalogues which are children of this broker in the catalogue hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCatalogueView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this catalogue only.

CompliancemandatoryThis method is must be implemented.
MethodgetCanonicalUnitProcessorQuery
Description

Gets a canonical unit processor query.

Returnosid.offering.rules.CanonicalUnitProcessorQuerythe canonical unit processor query
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorsByQuery
Description

Gets a list of CanonicalUnitProcessors matching the given search.

Parametersosid.offering.rules.CanonicalUnitProcessorQuerycanonicalUnitProcessorQuerythe canonical unit processor query
Returnosid.offering.rules.CanonicalUnitProcessorListthe returned CanonicalUnitProcessorList
ErrorsNULL_ARGUMENT canonicalUnitProcessorQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitProcessorQuery is not of this service
CompliancemandatoryThis method must be implemented.