Interface RouteSegmentSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface RouteSegmentSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByStartingInstructions

      void orderByStartingInstructions(SearchOrderStyle style)
      Specifies a preference for oredering the results by starting instructions.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByEndingInstructions

      void orderByEndingInstructions(SearchOrderStyle style)
      Specifies a preference for oredering the results by ending instructions.
      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 oredering the results by distance.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByETA

      void orderByETA(SearchOrderStyle style)
      Specifies a preference for oredering the results by estimated travel time.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRoute

      void orderByRoute(SearchOrderStyle style)
      Specifies a preference for oredering the results by path.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRouteSearchOrder

      boolean supportsRouteSearchOrder()
      Tests if a search order for the route is available.
      Returns:
      true if a route search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRouteSearchOrder

      RouteSearchOrder getRouteSearchOrder()
      Gets a route search order.
      Returns:
      the path search order
      Throws:
      UnimplementedException - supportsRouteSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRouteSearchOrder()} is {@code true} .

    • orderByPath

      void orderByPath(SearchOrderStyle style)
      Specifies a preference for oredering the results by path.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSearchOrder

      boolean supportsPathSearchOrder()
      Tests if a search order for the path is available.
      Returns:
      true if a path search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPathSearchOrder

      PathSearchOrder getPathSearchOrder()
      Gets a path search order.
      Returns:
      the path search order
      Throws:
      UnimplementedException - supportsPathSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPathSearchOrder()} is {@code true} .

    • getRouteSegmentSearchOrderRecord

      RouteSegmentSearchOrderRecord getRouteSegmentSearchOrderRecord(Type routeSegmentRecordType) throws OperationFailedException
      Gets the route segment search order record corresponding to the given route segment Type . Multiple retrievals return the same underlying object.
      Parameters:
      routeSegmentRecordType - a route segment record type
      Returns:
      the route segment search order record
      Throws:
      NullArgumentException - routeSegmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(routeSegmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.