| Interface | osid.ontology.rules.RelevancyEnablerQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods for searching among  This session defines views that offer differing behaviors for searching. 
  Relevancy enablers may have a query record indicated by 
                their respective record types. The query record is accessed 
                via the   | ||
| Method | getOntologyId | ||
| Description | 
                     Gets the   | ||
| Return | osid.id.Id | the  Ontology Id  associated with this session  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOntology | ||
| Description | 
                     Gets the   | ||
| Return | osid.ontology.Ontology | the ontology | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearchRelevancyEnablers | ||
| Description | 
                     Tests if this user can perform   | ||
| Return | boolean |  false  if search methods are not authorized,  true 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedOntologyView | ||
| 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.  | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedOntologyView | ||
| Description | 
                     Isolates the view for methods in this session. An isolated view restricts lookups to this ontology only.  | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getRelevancyEnablerQuery | ||
| Description | 
                     Gets a relevancy enabler query.  | ||
| Return | osid.ontology.rules.RelevancyEnablerQuery | the relevancy enabler query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelevancyEnablersByQuery | ||
| Description | 
                     Gets a list of   | ||
| Parameters | osid.ontology.rules.RelevancyEnablerQuery | relevancyEnablerQuery | the relevancy enabler query | 
| Return | osid.ontology.rules.RelevancyEnablerList | the returned  RelevancyEnablerList   | |
| Errors | NULL_ARGUMENT |  relevancyEnablerQuery  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED |  relevancyEnablerQuery  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |