Interface CookbookLookupSession

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

This session provides methods for retrieving Cookbook objects. The Cookbook represents a collection of recipes.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

  • Method Details

    • canLookupCookbooks

      boolean canLookupCookbooks()
      Tests if this user can perform Cookbook 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.

    • useComparativeCookbookView

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

    • usePlenaryCookbookView

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

    • getCookbook

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

    • getCookbooksByIds

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

    • getCookbooksByGenusType

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

    • getCookbooksByParentGenusType

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

    • getCookbooksByRecordType

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

    • getCookbooksByProvider

      CookbookList getCookbooksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets an CookbookList from the given provider. In plenary mode, the returned list contains all known cookbooks or an error results. Otherwise, the returned list may contain only those cookbooks that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Cookbook list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCookbooks

      CookbookList getCookbooks() throws OperationFailedException, PermissionDeniedException
      Gets all Cookbooks . In plenary mode, the returned list contains all known cookbooks or an error results. Otherwise, the returned list may contain only those cookbooks that are accessible through this session.
      Returns:
      a list of Cookbooks
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.