Interface EdgeEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
EdgeEnablerSearchSession
public interface EdgeEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getGraphId

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

    • getGraph

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

    • canSearchEdgeEnablers

      boolean canSearchEdgeEnablers()
      Tests if this user can perform EdgeEnabler 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.

    • useFederatedGraphView

      void useFederatedGraphView()
      Federates the view for methods in this session. A federated view will include edge enablers in ontologies which are children of this broker in the graph hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedGraphView

      void useIsolatedGraphView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this graph only.
      Compliance:
      mandatory - This method is must be implemented.

    • getEdgeEnablerQuery

      EdgeEnablerQuery getEdgeEnablerQuery()
      Gets an edge enabler query.
      Returns:
      the edge enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeEnablersByQuery

      EdgeEnablerList getEdgeEnablersByQuery(EdgeEnablerQuery edgeEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of EdgeEnablers matching the given edge enabler query.
      Parameters:
      edgeEnablerQuery - the edge enabler query query
      Returns:
      the returned EdgeEnablerList
      Throws:
      NullArgumentException - edgeEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - edgeEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.