OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerQuerySession
Implementsosid.OsidSession
Description

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

This session defines views that offer differing behaviors for searching.

  • federated ontology view: searches include relevancy enablers in ontologies of which this ontology is an ancestor in the ontology hierarchy
  • isolated ontology view: searches are restricted to relevancy enablers in this ontology

Relevancy enablers may have a query record indicated by their respective record types. The query record is accessed via the RelevancyEnablerQuery.

MethodgetOntologyId
Description

Gets the Ontology Id associated with this session.

Returnosid.id.Idthe Ontology Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOntology
Description

Gets the Ontology associated with this session.

Returnosid.ontology.Ontologythe ontology
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRelevancyEnablers
Description

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

Federates the view for methods in this session. A federated view will include relevancy enablers in ontologies which are children of this broker in the ontology hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOntologyView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRelevancyEnablerQuery
Description

Gets a relevancy enabler query.

Returnosid.ontology.rules.RelevancyEnablerQuerythe relevancy enabler query
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersByQuery
Description

Gets a list of RelevancyEnablers matching the given relevancy enabler query.

Parametersosid.ontology.rules.RelevancyEnablerQueryrelevancyEnablerQuerythe relevancy enabler query
Returnosid.ontology.rules.RelevancyEnablerListthe returned RelevancyEnablerList
ErrorsNULL_ARGUMENT relevancyEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED relevancyEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.