Interface GraphLookupSession

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

This session provides methods for retrieving Graph objects. The Graph represents a collection of nodes and edges.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Graphs it can access, without breaking execution. However, an assessment may only be useful if all Graphs referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupGraphs

      boolean canLookupGraphs()
      Tests if this user can perform Graph 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeGraphView

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

    • usePlenaryGraphView

      void usePlenaryGraphView()
      A complete view of the Graph 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.

    • getGraph

      Graph getGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Graph specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Graph may have a different Id than requested, such as the case where a duplicate Id was assigned to a Graph and retained for compatibility.
      Parameters:
      graphId - Id of the Graph
      Returns:
      the graph
      Throws:
      NotFoundException - graphId not found
      NullArgumentException - graphId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getGraphsByIds

      GraphList getGraphsByIds(IdList graphIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a GraphList corresponding to the given IdList . In plenary mode, the returned list contains all of the graphs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Graphs may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      graphIds - the list of Ids to retrieve
      Returns:
      the returned Graph list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - graphIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGraphsByGenusType

      GraphList getGraphsByGenusType(Type graphGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a GraphList corresponding to the given graph genus Type which does not include graphs of types derived from the specified Type . In plenary mode, the returned list contains all known graphs or an error results. Otherwise, the returned list may contain only those graphs that are accessible through this session.
      Parameters:
      graphGenusType - a graph genus type
      Returns:
      the returned Graph list
      Throws:
      NullArgumentException - graphGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGraphsByParentGenusType

      GraphList getGraphsByParentGenusType(Type graphGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a GraphList corresponding to the given graph genus Type and include any additional graphs with genus types derived from the specified Type . In plenary mode, the returned list contains all known graphs or an error results. Otherwise, the returned list may contain only those graphs that are accessible through this session.
      Parameters:
      graphGenusType - a graph genus type
      Returns:
      the returned Graph list
      Throws:
      NullArgumentException - graphGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGraphsByRecordType

      GraphList getGraphsByRecordType(Type graphRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a GraphList containing the given graph record Type . In plenary mode, the returned list contains all known graphs or an error results. Otherwise, the returned list may contain only those graphs that are accessible through this session.
      Parameters:
      graphRecordType - a graph record type
      Returns:
      the returned Graph list
      Throws:
      NullArgumentException - graphRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGraphsByProvider

      GraphList getGraphsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a GraphList for the given provider. In plenary mode, the returned list contains all known graphs or an error results. Otherwise, the returned list may contain only those graphs that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Graph list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGraphs

      GraphList getGraphs() throws OperationFailedException, PermissionDeniedException
      Gets all Graphs . In plenary mode, the returned list contains all known graphs or an error results. Otherwise, the returned list may contain only those graphs that are accessible through this session.
      Returns:
      a list of Graphs
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.