Interface DirectionLookupSession

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

This session defines methods for retrieving directions.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated cookbook view: All direction methods in this session operate, retrieve and pertain to directions defined explicitly in the current cookbook. Using an isolated view is useful for managing Directions with the DirectionAdminSession .
  • federated cookbook view: All direction lookup methods in this session operate, retrieve and pertain to all directions defined in this coo book and any other directions implicitly available in this coo book through cookbook inheritence.

The methods useFederatedCookbookView() and useIsolatedCookbookView() behave as a radio group and one should be selected before invoking any lookup methods.

Directions may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Directions .

  • 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.

    • canLookupDirections

      boolean canLookupDirections()
      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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeDirectionView

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

    • usePlenaryDirectionView

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

    • 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 retrievals to this cookbook only.
      Compliance:
      mandatory - This method is must be implemented.

    • getDirection

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

    • getDirectionsByIds

      DirectionList getDirectionsByIds(IdList directionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a DirectionList corresponding to the given IdList . In plenary mode, the returned list contains all of the directions 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 Directions may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      directionIds - the list of Ids to retrieve
      Returns:
      the returned Direction list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - directionIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDirectionsByGenusType

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

    • getDirectionsByParentGenusType

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

    • getDirectionsByRecordType

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

    • getDirectionsForRecipe

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

    • getDirections

      DirectionList getDirections() throws OperationFailedException, PermissionDeniedException
      Gets all directions. In plenary mode, the returned list contains all of the directions, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Directions may be omitted from the list and may present the elements in any order including returning a unique set.
      Returns:
      the returned Direction list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.