Interface RelevancyEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RelevancyEnablerSearchSession
public interface RelevancyEnablerQuerySession extends OsidSession

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.

  • Method Details

    • getOntologyId

      Id getOntologyId()
      Gets the Ontology Id associated with this session.
      Returns:
      the Ontology Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOntology

      Ontology getOntology() throws OperationFailedException, PermissionDeniedException
      Gets the Ontology associated with this session.
      Returns:
      the ontology
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchRelevancyEnablers

      boolean canSearchRelevancyEnablers()
      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.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedOntologyView

      void useFederatedOntologyView()
      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.

    • useIsolatedOntologyView

      void useIsolatedOntologyView()
      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.

    • getRelevancyEnablerQuery

      RelevancyEnablerQuery getRelevancyEnablerQuery()
      Gets a relevancy enabler query.
      Returns:
      the relevancy enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyEnablersByQuery

      RelevancyEnablerList getRelevancyEnablersByQuery(RelevancyEnablerQuery relevancyEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RelevancyEnablers matching the given relevancy enabler query.
      Parameters:
      relevancyEnablerQuery - the relevancy enabler query
      Returns:
      the returned RelevancyEnablerList
      Throws:
      NullArgumentException - relevancyEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relevancyEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.