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

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

This session defines views that offer differing behaviors for searching.

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

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

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

Tests if this user can perform CanonicalUnitProcessorEnabler 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 enablers 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.
MethodgetCanonicalUnitProcessorEnablerQuery
Description

Gets a canonical unit processor enabler query.

Returnosid.offering.rules.CanonicalUnitProcessorEnablerQuerythe canonical unit processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorEnablersByQuery
Description

Gets a list of CanonicalUnitProcessorEnablers matching the given search.

Parametersosid.offering.rules.CanonicalUnitProcessorEnablerQuerycanonicalUnitProcessorEnablerQuerythe canonical unit processor enabler query
Returnosid.offering.rules.CanonicalUnitProcessorEnablerListthe returned CanonicalUnitProcessorEnablerList
ErrorsNULL_ARGUMENT canonicalUnitProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED canonicalUnitProcessorEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.