Interface DirectionQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
DirectionSearchSession
public interface DirectionQuerySession extends OsidSession

This session provides methods for searching among Direction objects. The search query is constructed using the DirectionQuery.

This session defines views that offer differing behaviors for searching.

  • federated cookbook view: searches include directions in cookbooks of which this cookbook is an ancestor in the cookbook hierarchy
  • isolated cookbook view: searches are restricted to directions in this cookbooks

Directions may have a query record indicated by their respective record types. The query record is accessed via the DirectionQuery.

  • Method Details

    • getCookbookId

      Id getCookbookId()
      Gets the Cookbook Id associated with this session.
      Returns:
      the Cookbook Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCookbook

      Cookbook getCookbook() throws OperationFailedException, PermissionDeniedException
      Gets the Cookbook associated with this session.
      Returns:
      the cookbook
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchDirections

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

    • useFederatedCookbookView

      void useFederatedCookbookView()
      Federates the view for methods in this session. A federated view will include directions in cookbooks which are children of this cookbook in the cookbook hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCookbookView

      void useIsolatedCookbookView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this cookbook only.
      Compliance:
      mandatory - This method is must be implemented.

    • getDirectionQuery

      DirectionQuery getDirectionQuery()
      Gets a direction query.
      Returns:
      the direction query
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionsByQuery

      DirectionList getDirectionsByQuery(DirectionQuery directionQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Directions matching the given direction query.
      Parameters:
      directionQuery - the direction query
      Returns:
      the returned DirectionList
      Throws:
      NullArgumentException - directionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - directionQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.