Interface EdgeSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface EdgeSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderBySourceNode

      void orderBySourceNode(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the source node.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsSourceNodeSearchOrder

      boolean supportsSourceNodeSearchOrder()
      Tests if a source node search order is available.
      Returns:
      true if a node search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSourceNodeSearchOrder

      NodeSearchOrder getSourceNodeSearchOrder()
      Gets a source node search order.
      Returns:
      a node search order
      Throws:
      UnimplementedException - supportsSourceNodeSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSourceNodeSearchOrder()} is {@code true} .

    • orderByDestinationNode

      void orderByDestinationNode(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the destination node.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsDestinationNodeSearchOrder

      boolean supportsDestinationNodeSearchOrder()
      Tests if a destination node search order is available.
      Returns:
      true if a node search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDestinationNodeSearchOrder

      NodeSearchOrder getDestinationNodeSearchOrder()
      Gets a destination node search order.
      Returns:
      a node search order
      Throws:
      UnimplementedException - supportsDestinationNodeSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDestinationNodeSearchOrder()} is {@code true} .

    • orderByDirectional

      void orderByDirectional(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the directionality.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByBiDirectional

      void orderByBiDirectional(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the directionality.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCost

      void orderByCost(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the edge cost.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDistance

      void orderByDistance(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the edge distance.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeSearchOrderRecord

      EdgeSearchOrderRecord getEdgeSearchOrderRecord(Type edgeRecordType) throws OperationFailedException
      Gets the edge search order record corresponding to the given edge record Type . Multiple retrievals return the same underlying object.
      Parameters:
      edgeRecordType - an edge record type
      Returns:
      the edge search order record
      Throws:
      NullArgumentException - edgeRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(edgeRecordType) is false
      Compliance:
      mandatory - This method must be implemented.