Interface EdgeEnablerRuleLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface EdgeEnablerRuleLookupSession extends OsidSession

This session provides methods to retrieve EdgeEnabler to Edge mappings. An Edge with multiple EdgeEnablers means any positive rule evaluation across the enablers result in an effective Edge .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated graph view: All methods in this session operate, retrieve and pertain edge enablers defined explicitly in the current graph
  • federated graph view: All methods in this session operate, retrieve and pertain to all edge enablers defined in this graph and any other edge enablers implicitly available in this graph through graph inheritence.

  • 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.

    • canLookupEdgeEnablerRules

      boolean canLookupEdgeEnablerRules()
      Tests if this user can perform lookups of edge enabler/edge mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeEdgeEnablerRuleView

      void useComparativeEdgeEnablerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryEdgeEnablerRuleView

      void usePlenaryEdgeEnablerRuleView()
      A complete view of the EdgeEnabler and Edge returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is 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 graph 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.

    • getEdgeEnablerIdsForEdge

      IdList getEdgeEnablerIdsForEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the EdgeEnabler Id associated with an Edge .
      Parameters:
      edgeId - Id of the Edge
      Returns:
      the edge enabler Ids
      Throws:
      NotFoundException - edgeId is not found
      NullArgumentException - edgeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeEnablersForEdge

      EdgeEnablerList getEdgeEnablersForEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the EdgeEnabler associated with an Edge .
      Parameters:
      edgeId - Id of the Edge
      Returns:
      the edge enablers
      Throws:
      NotFoundException - edgeId is not found
      NullArgumentException - edgeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeIdsByEdgeEnabler

      IdList getEdgeIdsByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Edge Ids mapped to an EdgeEnabler .
      Parameters:
      edgeEnablerId - Id of an EdgeEnabler
      Returns:
      list of edge Ids
      Throws:
      NotFoundException - edgeEnablerId is not found
      NullArgumentException - edgeEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getEdgesByEdgeEnabler

      EdgeList getEdgesByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Edges mapped to an EdgeEnabler .
      Parameters:
      edgeEnablerId - Id of an EdgeEnabler
      Returns:
      list of edges
      Throws:
      NotFoundException - edgeEnablerId is not found
      NullArgumentException - edgeEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.