OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.CookbookLookupSession
Implementsosid.OsidSession
Description

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
MethodcanLookupCookbooks
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCookbookView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCookbookView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetCookbook
Description

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.

Parametersosid.id.IdjouralId Id of the Cookbook
Returnosid.recipe.Cookbookthe cookbook
ErrorsNOT_FOUND cookbookId not found
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCookbooksByIds
Description

Gets an CookbookList corresponding to the given IdList. In plenary mode, the returned list contains all of the cook books 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.

Parametersosid.id.IdListcookbookIdsthe list of Ids to retrieve
Returnosid.recipe.CookbookListthe returned Cookbook list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT cookbookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbooksByGenusType
Description

Gets an CookbookList corresponding to the given cook book genus Type which does not include cook books of genus types derived from the specified Type. In plenary mode, the returned list contains all known cook books or an error results. Otherwise, the returned list may contain only those cook books that are accessible through this session.

Parametersosid.type.TypecookbookGenusTypea cook book genus type
Returnosid.recipe.CookbookListthe returned Cookbook list
ErrorsNULL_ARGUMENT cookbookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbooksByParentGenusType
Description

Gets an CookbookList corresponding to the given cook book genus Type and include any additional cook books with genus types derived from the specified Type. In plenary mode, the returned list contains all known cook books or an error results. Otherwise, the returned list may contain only those cook books that are accessible through this session.

Parametersosid.type.TypecookbookGenusTypea cook book genus type
Returnosid.recipe.CookbookListthe returned Cookbook list
ErrorsNULL_ARGUMENT cookbookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbooksByRecordType
Description

Gets an CookbookList containing the given cook book record Type. In plenary mode, the returned list contains all known cook books or an error results. Otherwise, the returned list may contain only those cook books that are accessible through this session.

Parametersosid.type.TypecookbookRecordTypea cook book record type
Returnosid.recipe.CookbookListthe returned Cookbook list
ErrorsNULL_ARGUMENT cookbookRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbooksByProvider
Description

Gets an CookbookList from the given provider . In plenary mode, the returned list contains all known cook books or an error results. Otherwise, the returned list may contain only those cook books that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.recipe.CookbookListthe returned Cookbook list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCookbooks
Description

Gets all Cookbooks. In plenary mode, the returned list contains all known cook books or an error results. Otherwise, the returned list may contain only those cook books that are accessible through this session.

Returnosid.recipe.CookbookLista list of Cookbooks
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.