Package org.osid.recipe

package org.osid.recipe

The Open Service Interface Definitions for the org.osid.recipe service.

The Recipe OSID is the how-to service providing a means for managing lists of directions to create or do something. The Recipe OSID can be used in conjunction with the Resourcing OSID and the Tracking OSID to provide instructions or stock answers on accomplishing a variety of tasks. The Recipe OSID may also be used alongside the Learning OSID for managing the skills required to complete various tasks and it may be used in conjunction with the Inventory OSID for managing an inventory of materials required to accomplish jobs. While the Recipe OSID may also be used with the Checklist OSID for a simplified tracking of progress, it can always be used to store your favorite recipes.

Recipe

A Recipe is an OsidObject which represents a set of Directions to achieve some goal.

Direction

A Direction is an instruction or a process step. A Direction may have some Assets to illustrate the instruction.

Directions may be further broken down into Procedures and include a specified list of materials or ingredients for accomplishing the step.

Procedure

Procedures can be used to specifically describe an action that needs to be executed within a Direction . Normalization of procedures allow for the linking to learning Objectives to describe the skill or knowledge necessary for accomplishing the task.

Ingredient

An Ingredient is a quantity of some group of items, or inventory Stock , managed in the Inventory OSID. The units of a quantity are expressed as a Type such as "units," "pounds," or "cups."

Cookbook Cataloging

Recipes , Directions, and Procedures are organized into federatable OsidCatalogs called Cookbooks .

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.recipe.batch	The Open Service Interface Definitions for the org.osid.recipe.batch service.
org.osid.recipe.records

Interfaces

Class	Description
Cookbook	An Cookbook represents a collection of awards and procedures.
CookbookAdminSession	This session creates, updates, and deletes Cookbooks .
CookbookForm	This is the form for creating and updating Cookbooks .
CookbookHierarchyDesignSession	This session manages a hierarchy of cookbooks.
CookbookHierarchySession	This session defines methods for traversing a hierarchy of Cookbook objects.
CookbookList	Like all OsidLists , CookbookList provides a means for accessing Cookbook elements sequentially either one at a time or many at a time.
CookbookLookupSession	This session provides methods for retrieving Cookbook objects.
CookbookNode	This interface is a container for a partial hierarchy retrieval.
CookbookNodeList	Like all OsidLists , CookbookNodeList provides a means for accessing CookbookNode elements sequentially either one at a time or many at a time.
CookbookNotificationSession	This session defines methods to receive notifications on adds/changes to Cookbook objects.
CookbookQuery	This is the query for searching for cookbooks.
CookbookQueryInspector	This is the query inspector for searching for cookbooks.
CookbookQuerySession	This session provides methods for searching Cookbook catalogs.
CookbookReceiver	The cookbook receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Cookbook objects.
CookbookSearch	The search interface for governing cookbook searches.
CookbookSearchOrder	An interface for specifying the ordering of search results.
CookbookSearchResults	This interface provides a means to capture results of a search.
CookbookSearchSession	This session provides methods for searching Cookbook objects.
Direction	A Direction is an instruction.
DirectionAdminSession	This session creates, updates, and deletes Directions .
DirectionCookbookAssignmentSession	This session provides methods to re-assign Directions to Cookbook mappings.
DirectionCookbookSession	This session provides methods to retrieve Direction to Cookbook directions.
DirectionForm	This is the form for creating and updating Directions .
DirectionList	Like all OsidLists , DirectionList provides a means for accessing Direction elements sequentially either one at a time or many at a time.
DirectionLookupSession	This session defines methods for retrieving directions.
DirectionNotificationSession	This session defines methods to receive notifications on adds/changes to Direction objects in this Cookbook .
DirectionQuery	This is the query for searching directions.
DirectionQueryInspector	This is the query inspector for examining direction queries.
DirectionQuerySession	This session provides methods for searching among Direction objects.
DirectionReceiver	The direction receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted directions.
DirectionSearch	The search interface for governing direction searches.
DirectionSearchOrder	An interface for specifying the ordering of search results.
DirectionSearchResults	This interface provides a means to capture results of a search.
DirectionSearchSession	This session provides methods for searching among Direction objects.
DirectionSmartCookbookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Ingredient	An Ingredient represents an item used in a Recipe .
IngredientForm	This is the form for creating and updating Ingredients .
IngredientList	Like all OsidLists , IngredientList provides a means for accessing Ingredient elements sequentially either one at a time or many at a time.
IngredientQuery	This is the query for searching ingredients.
IngredientQueryInspector	This is the query inspector for examining ingredient queries.
Procedure	A Procedure is an action.
ProcedureAdminSession	This session creates, updates, and deletes Procedures .
ProcedureCookbookAssignmentSession	This session provides methods to re-assign Procedures to Cookbooks .
ProcedureCookbookSession	This session provides methods to retrieve Procedure to Cookbook mappings.
ProcedureForm	This is the form for creating and updating Procedure objects.
ProcedureList	Like all OsidLists , ProcedureList provides a means for accessing Procedure elements sequentially either one at a time or many at a time.
ProcedureLookupSession	This session defines methods for retrieving procedures.
ProcedureNotificationSession	This session defines methods to receive notifications on adds/changes to Procedure objects.
ProcedureQuery	This is the query for searching procedures.
ProcedureQueryInspector	The inspector for examining procedure queries.
ProcedureQuerySession	This session provides methods for searching Procedure objects.
ProcedureReceiver	The procedure receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted procedures.
ProcedureSearch	The search interface for governing procedure searches.
ProcedureSearchOrder	An interface for specifying the ordering of search results.
ProcedureSearchResults	This interface provides a means to capture results of a search.
ProcedureSearchSession	This session provides methods for searching Procedure objects.
ProcedureSmartCookbookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Recipe	A Recipe .
RecipeAdminSession	This session creates, updates, and deletes Recipes .
RecipeCookbookAssignmentSession	This session provides methods to re-assign Recipes to Cookbook mappings.
RecipeCookbookSession	This session provides methods to retrieve Recipe to Cookbook ingredients.
RecipeForm	This is the form for creating and updating Recipes .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RecipeAdminSession .
RecipeList	Like all OsidLists , RecipeList provides a means for accessing Recipe elements sequentially either one at a time or many at a time.
RecipeLookupSession	This session provides methods for retrieving Recipe objects.
RecipeManager	The recipe manager provides access to procedure sessions and provides interoperability tests for various aspects of this service.
RecipeNotificationSession	This session defines methods to receive notifications on adds/changes to Recipe objects in this Cookbook .
RecipeProfile	The recipe profile describes the interoperability among recipe services.
RecipeProxyManager	The recipe manager provides access to procedure sessions and provides interoperability tests for various aspects of this service.
RecipeQuery	This is the query for searching recipes.
RecipeQueryInspector	This is the query inspector for examining recipe queries.
RecipeQuerySession	This session provides methods for searching among Recipe objects.
RecipeReceiver	The recipe receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Recipe objects.
RecipeSearch	The search interface for governing recipe searches.
RecipeSearchOrder	An interface for specifying the ordering of search results.
RecipeSearchResults	This interface provides a means to capture results of a search.
RecipeSearchSession	This session provides methods for searching among Recipe objects.
RecipeSmartCookbookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.