Interface EdgeSearchResults

All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
public interface EdgeSearchResults extends OsidSearchResults

This interface provides a means to capture results of a search.

  • Method Details

    • getEdges

      EdgeList getEdges()
      Gets the edge list resulting from a search.
      Returns:
      the edge list
      Throws:
      IllegalStateException - list already retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeQueryInspector

      EdgeQueryInspector getEdgeQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the edge query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeSearchResultsRecord

      EdgeSearchResultsRecord getEdgeSearchResultsRecord(Type edgeSearchRecordType) throws OperationFailedException
      Gets the edge search results record corresponding to the given edge search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      edgeSearchRecordType - an edge search record type
      Returns:
      the edge search results record
      Throws:
      NullArgumentException - edgeSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(edgeSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.