public interface RecipeProxyManager extends OsidProxyManager, RecipeProfile
The recipe manager provides access to procedure sessions and provides
interoperability tests for various aspects of this service. Methods in
this manager accept a Proxy
for passing information from a
server environment. The sessions included in this manager are:
RecipeLookupSession:
a session to retrieve recipes
RecipeQuerySession:
a session to query for recipes
RecipeSearchSession:
a session to search for
recipes RecipeAdminSession:
a session to create and delete
recipes RecipeNotificationSession:
a session to receive
notifications pertaining to recipe changes RecipeCookbookSession:
a session to looking
mappings of recipes to cook books RecipeCookbookAssignmentSession:
a session to
manage recipe to cook book mappings RecipeCookbookAssignmentSession:
a session to
manage dynamic cook books of recipes DirectionLookupSession:
a session to retrieve
directions DirectionQuerySession:
a session to query for
directions DirectionSearchSession:
a session to search for
directions DirectionAdminSession:
a session to create and
delete directions DirectionNotificationSession:
a session to receive
notifications pertaining to direction changes DirectionCookbookSession:
a session to look up
direction cook book mappings DirectionCookbookAssignmentSession:
a session to
manage direction to cook book mappings DirectionSmartCookbookSession:
a session to manage
dynamic cook books of directions ProcedureLookupSession:
a session to lookup
procedures ProcedureQuerySession:
a session to query
procedures ProcedureSearchSession:
a session to search
procedures ProcedureAdminSession:
a session to manage
procedures ProcedureNotificationSession:
a session to
subscribe to notifications of procedure changes ProcedureCookbookSession:
a session to lookup
procedure cook book mappings ProcedureCookbookAssignmentSession:
a session to
manage procedure cook book mappings ProcedureSmartCookbookSession:
a session to manage
smart cook books of procedures CookbookLookupSession:
a session to retrieve cook
books CookbookQuerySession:
a session to query cook
books CookbookSearchSession:
a session to search for
cook books CookbookAdminSession:
a session to create, update
and delete cook books CookbookNotificationSession:
a session to receive
notifications for changes in cook books CookbookHierarchyTraversalSession:
a session to
traverse hierarchies of cook books CookbookHierarchyDesignSession:
a session to
manage hierarchies of cook books Modifier and Type | Method and Description |
---|---|
CookbookAdminSession |
getCookbookAdminSession(Proxy proxy)
Gets the
OsidSession associated with the cook book
administrative service. |
CookbookHierarchyDesignSession |
getCookbookHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the cook book
hierarchy design service. |
CookbookHierarchySession |
getCookbookHierarchySession(Proxy proxy)
Gets the
OsidSession associated with the cook book
hierarchy service. |
CookbookLookupSession |
getCookbookLookupSession(Proxy proxy)
Gets the
OsidSession associated with the cook book
lookup service. |
CookbookNotificationSession |
getCookbookNotificationSession(CookbookReceiver cookbookReceiver,
Proxy proxy)
Gets the
OsidSession associated with the cook book
notification service. |
CookbookQuerySession |
getCookbookQuerySession(Proxy proxy)
Gets the
OsidSession associated with the cook book
query service. |
CookbookSearchSession |
getCookbookSearchSession(Proxy proxy)
Gets the
OsidSession associated with the cook book
search service. |
DirectionAdminSession |
getDirectionAdminSession(Proxy proxy)
Gets the
OsidSession associated with the direction
administration service. |
DirectionAdminSession |
getDirectionAdminSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the direction
administration service for the given cookbook. |
DirectionCookbookAssignmentSession |
getDirectionCookbookAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning mappings
to cook books. |
DirectionCookbookSession |
getDirectionCookbookSession(Proxy proxy)
Gets the
OsidSession to lookup direction/cook book
ingredients. |
DirectionLookupSession |
getDirectionLookupSession(Proxy proxy)
Gets the
OsidSession associated with the direction
lookup service. |
DirectionLookupSession |
getDirectionLookupSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the direction
lookup service for the given cookbook. |
DirectionNotificationSession |
getDirectionNotificationSession(DirectionReceiver directionReceiver,
Proxy proxy)
Gets the
OsidSession associated with the direction
notification service. |
DirectionNotificationSession |
getDirectionNotificationSessionForCookbook(DirectionReceiver directionReceiver,
Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the direction
notification service for the given cookbook. |
DirectionQuerySession |
getDirectionQuerySession(Proxy proxy)
Gets the
OsidSession associated with the direction
query service. |
DirectionQuerySession |
getDirectionQuerySessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the direction
query service for the given cookbook. |
DirectionSearchSession |
getDirectionSearchSession(Proxy proxy)
Gets the
OsidSession associated with the direction
search service. |
DirectionSearchSession |
getDirectionSearchSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the direction
search service for the given cookbook. |
DirectionSmartCookbookSession |
getDirectionSmartCookbookSession(Id cookbookId,
Proxy proxy)
Gets the
OsidSession to manage locatin smart cook
books. |
ProcedureAdminSession |
getProcedureAdminSession(Proxy proxy)
Gets the
OsidSession associated with the procedure
administration service. |
ProcedureAdminSession |
getProcedureAdminSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the procedure
administration service for the given cookbook. |
ProcedureCookbookAssignmentSession |
getProcedureCookbookAssignmentSession(Proxy proxy)
Gets the session for assigning procedure to cook book mappings.
|
ProcedureCookbookSession |
getProcedureCookbookSession(Proxy proxy)
Gets the session for retrieving procedure to cook book mappings.
|
ProcedureLookupSession |
getProcedureLookupSession(Proxy proxy)
Gets the
OsidSession associated with the procedure
lookup service. |
ProcedureLookupSession |
getProcedureLookupSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the procedure
lookup service for the given cookbook. |
ProcedureNotificationSession |
getProcedureNotificationSession(ProcedureReceiver procedureReceiver,
Proxy proxy)
Gets the
OsidSession associated with the procedure
notification service. |
ProcedureNotificationSession |
getProcedureNotificationSessionForCookbook(ProcedureReceiver procedureReceiver,
Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the procedure
notification service for the given cookbook. |
ProcedureQuerySession |
getProcedureQuerySession(Proxy proxy)
Gets the
OsidSession associated with the procedure
query service. |
ProcedureQuerySession |
getProcedureQuerySessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the procedure
query service for the given cookbook. |
ProcedureSearchSession |
getProcedureSearchSession(Proxy proxy)
Gets the
OsidSession associated with the procedure
search service. |
ProcedureSearchSession |
getProcedureSearchSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the procedure
search service for the given cookbook. |
ProcedureSmartCookbookSession |
getProcedureSmartCookbookSession(Id cookbookId,
Proxy proxy)
Gets the session associated with the procedure smart cook book for the
given cookbook.
|
RecipeAdminSession |
getRecipeAdminSession(Proxy proxy)
Gets the
OsidSession associated with the recipe
administration service. |
RecipeAdminSession |
getRecipeAdminSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the recipe
administration service for the given cookbook. |
RecipeBatchProxyManager |
getRecipeBatchProxyManager()
Gets the
RecipieBatchProxyManager . |
RecipeCookbookAssignmentSession |
getRecipeCookbookAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning recipes
to cook books. |
RecipeCookbookSession |
getRecipeCookbookSession(Proxy proxy)
Gets the
OsidSession to lookup recipe/cook book
mappings. |
RecipeLookupSession |
getRecipeLookupSession(Proxy proxy)
Gets the
OsidSession associated with the recipe lookup
service. |
RecipeLookupSession |
getRecipeLookupSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the recipe lookup
service for the given cookbook. |
RecipeNotificationSession |
getRecipeNotificationSession(RecipeReceiver recipeReceiver,
Proxy proxy)
Gets the
OsidSession associated with the recipe
notification service. |
RecipeNotificationSession |
getRecipeNotificationSessionForCookbook(RecipeReceiver recipeReceiver,
Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the recipe
notification service for the given cookbook. |
RecipeQuerySession |
getRecipeQuerySession(Proxy proxy)
Gets the
OsidSession associated with the recipe query
service. |
RecipeQuerySession |
getRecipeQuerySessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the recipe query
service for the given cookbook. |
RecipeSearchSession |
getRecipeSearchSession(Proxy proxy)
Gets the
OsidSession associated with the recipe search
service. |
RecipeSearchSession |
getRecipeSearchSessionForCookbook(Id cookbookId,
Proxy proxy)
Gets the
OsidSession associated with the recipe search
service for the given cookbook. |
RecipeSmartCookbookSession |
getRecipeSmartCookbookSession(Id cookbookId,
Proxy proxy)
Gets the
OsidSession to manage recipe smart cook books. |
changeBranch, initialize, rollbackService
close
getCookbookRecordTypes, getCookbookSearchRecordTypes, getDirectionRecordTypes, getDirectionSearchRecordTypes, getIngredientRecordTypes, getProcedureRecordTypes, getProcedureSearchRecordTypes, getRecipeRecordTypes, getRecipeSearchRecordTypes, supportsCookbookAdmin, supportsCookbookHierarchy, supportsCookbookHierarchyDesign, supportsCookbookLookup, supportsCookbookNotification, supportsCookbookQuery, supportsCookbookRecordType, supportsCookbookSearch, supportsCookbookSearchRecordType, supportsDirectionAdmin, supportsDirectionCookbook, supportsDirectionCookbookAssignment, supportsDirectionLookup, supportsDirectionNotification, supportsDirectionQuery, supportsDirectionRecordType, supportsDirectionSearch, supportsDirectionSearchRecordType, supportsDirectionSmartCookbook, supportsIngredientRecordType, supportsProcedureAdmin, supportsProcedureCookbook, supportsProcedureCookbookAssignment, supportsProcedureLookup, supportsProcedureNotification, supportsProcedureQuery, supportsProcedureRecordType, supportsProcedureSearch, supportsProcedureSearchRecordType, supportsProcedureSmartCookbook, supportsRecipeAdmin, supportsRecipeCookbook, supportsRecipeCookbookAssignment, supportsRecipeLookup, supportsRecipeNotification, supportsRecipeQuery, supportsRecipeRecordType, supportsRecipeSearch, supportsRecipeSearchRecordType, supportsRecipeSmartCookbook, supportsRecipieBatch, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RecipeLookupSession getRecipeLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the recipe lookup
service.proxy
- a proxy RecipeLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeLookup()
is false
optional
- This method must be implemented if
supportsRecipeLookup()
is true.
RecipeLookupSession getRecipeLookupSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the recipe lookup
service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeLookupSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRecipeLookup()
and
supportsVisibleFederation()
are true
RecipeQuerySession getRecipeQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the recipe query
service.proxy
- a proxy RecipeQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeQuery()
is false
optional
- This method must be implemented if
supportsRecipeQuery()
is true.
RecipeQuerySession getRecipeQuerySessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the recipe query
service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeQuerySession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRecipeQuery()
and
supportsVisibleFederation()
are true
RecipeSearchSession getRecipeSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the recipe search
service.proxy
- a proxy RecipeSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeSearch()
is false
optional
- This method must be implemented if
supportsRecipeSearch()
is true.
RecipeSearchSession getRecipeSearchSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the recipe search
service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeSearchSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRecipeSearch()
and
supportsVisibleFederation()
are true
RecipeAdminSession getRecipeAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the recipe
administration service.proxy
- a proxy RecipeAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeAdmin()
is false
optional
- This method must be implemented if
supportsRecipeAdmin()
is true.
RecipeAdminSession getRecipeAdminSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the recipe
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeAdminSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRecipeAdmin()
and
supportsVisibleFederation()
are true
RecipeNotificationSession getRecipeNotificationSession(RecipeReceiver recipeReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the recipe
notification service.recipeReceiver
- the notification callbackproxy
- a proxy RecipeNotificationSession
NullArgumentException
- recipeReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeNotification()
is false
optional
- This method must be implemented if
supportsRecipeNotification()
is true.
RecipeNotificationSession getRecipeNotificationSessionForCookbook(RecipeReceiver recipeReceiver, Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the recipe
notification service for the given cookbook.recipeReceiver
- the notification callbackcookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeNotificationSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- recipeReceiver,
cookbookId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRecipeNotification()
and
supportsVisibleFederation()
are true
RecipeCookbookSession getRecipeCookbookSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup recipe/cook book
mappings.proxy
- a proxy RecipeCookbookSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeCookbook()
is false
optional
- This method must be implemented if
supportsRecipeCookbook()
is true.
RecipeCookbookAssignmentSession getRecipeCookbookAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning recipes
to cook books.proxy
- a proxy RecipeCookbookAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeCookbookAssignment()
is false
optional
- This method must be implemented if
supportsRecipeCookbookAssignment()
is true.
RecipeSmartCookbookSession getRecipeSmartCookbookSession(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage recipe smart cook books.cookbookId
- the Id
of the Cookbook
proxy
- a proxy RecipeSmartCookbookSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecipeSmartCookbook()
is false
optional
- This method must be implemented if
supportsRecipeSmartCookbook()
is true.
DirectionLookupSession getDirectionLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the direction
lookup service.proxy
- a proxy DirectionLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionLookup()
is false
optional
- This method must be implemented if
supportsDirectionLookup()
is true.
DirectionLookupSession getDirectionLookupSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the direction
lookup service for the given cookbook.cookbookId
- the Id
of the cook bookproxy
- a proxy DirectionLookupSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionLookup()
and
supportsVisibleFederation()
are true
DirectionQuerySession getDirectionQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the direction
query service.proxy
- a proxy DirectionQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionQuery()
is false
optional
- This method must be implemented if
supportsDirectionQuery()
is true.
DirectionQuerySession getDirectionQuerySessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the direction
query service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy DirectionQuerySession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionQuery()
and
supportsVisibleFederation()
are true
DirectionSearchSession getDirectionSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the direction
search service.proxy
- a proxy DirectionSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionSearch()
is false
optional
- This method must be implemented if
supportsDirectionSearch()
is true.
DirectionSearchSession getDirectionSearchSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the direction
search service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy DirectionSearchSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionSearch()
and
supportsVisibleFederation()
are true
DirectionAdminSession getDirectionAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the direction
administration service.proxy
- a proxy DirectionAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionAdmin()
is false
optional
- This method must be implemented if
supportsDirectionAdmin()
is true.
DirectionAdminSession getDirectionAdminSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the direction
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy DirectionAdminSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionAdmin()
and
supportsVisibleFederation()
are true
DirectionNotificationSession getDirectionNotificationSession(DirectionReceiver directionReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the direction
notification service.directionReceiver
- the notification callbackproxy
- a proxy DirectionNotificationSession
NullArgumentException
- directionReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionNotification()
is false
optional
- This method must be implemented if
supportsDirectionNotification()
is true.
DirectionNotificationSession getDirectionNotificationSessionForCookbook(DirectionReceiver directionReceiver, Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the direction
notification service for the given cookbook.directionReceiver
- the notification callbackcookbookId
- the Id
of the Cookbook
proxy
- a proxy DirectionNotificationSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- directionReceiver,
cookbookId
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDirectionNotification()
and
supportsVisibleFederation()
are true
DirectionCookbookSession getDirectionCookbookSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup direction/cook book
ingredients.proxy
- a proxy DirectionCookbookSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionCookbook()
is false
optional
- This method must be implemented if
supportsDirectionCookbook()
is true.
DirectionCookbookAssignmentSession getDirectionCookbookAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning mappings
to cook books.proxy
- a proxy DirectionCookbookAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionCookbookAssignment()
is false
optional
- This method must be implemented if
supportsDirectionCookbookAssignment()
is
true.
DirectionSmartCookbookSession getDirectionSmartCookbookSession(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart cook
books.cookbookId
- the Id
of the Cookbook
proxy
- a proxy DirectionSmartCookbookSession
NotFoundException
- no cook book found by the given
Id
NullArgumentException
- cookbookId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDirectionSmartCookbook()
is false
optional
- This method must be implemented if
supportsDirectionSmartCookbook()
is true.
ProcedureLookupSession getProcedureLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the procedure
lookup service.proxy
- a proxy ProcedureLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureLookup()
is false
optional
- This method must be implemented if
supportsProcedureLookup()
is true.
ProcedureLookupSession getProcedureLookupSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the procedure
lookup service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy ProcedureLookupSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureLookup()
and
supportsVisibleFederation()
are true
ProcedureQuerySession getProcedureQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the procedure
query service.proxy
- a proxy ProcedureQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureQuery()
is false
optional
- This method must be implemented if
supportsProcedureQuery()
is true.
ProcedureQuerySession getProcedureQuerySessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the procedure
query service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy ProcedureQuerySession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureQuery()
and
supportsVisibleFederation()
are true
ProcedureSearchSession getProcedureSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the procedure
search service.proxy
- a proxy ProcedureSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureSearch()
is false
optional
- This method must be implemented if
supportsProcedureSearch()
is true.
ProcedureSearchSession getProcedureSearchSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the procedure
search service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy ProcedureSearchSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureSearch()
and
supportsVisibleFederation()
are true
ProcedureAdminSession getProcedureAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the procedure
administration service.proxy
- a proxy ProcedureAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureAdmin()
is false
optional
- This method must be implemented if
supportsProcedureAdmin()
is true.
ProcedureAdminSession getProcedureAdminSessionForCookbook(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the procedure
administration service for the given cookbook.cookbookId
- the Id
of the Cookbook
proxy
- a proxy ProcedureAdminSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- cookbookId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureAdmin()
and
supportsVisibleFederation()
are true
ProcedureNotificationSession getProcedureNotificationSession(ProcedureReceiver procedureReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the procedure
notification service.procedureReceiver
- the receiverproxy
- a proxy ProcedureNotificationSession
NullArgumentException
- procedureReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureNotification()
is false
optional
- This method must be implemented if
supportsProcedureNotification()
is true.
ProcedureNotificationSession getProcedureNotificationSessionForCookbook(ProcedureReceiver procedureReceiver, Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the procedure
notification service for the given cookbook.procedureReceiver
- the receivercookbookId
- the Id
of the Cookbook
proxy
- a proxy ProcedureNotificationSession
NotFoundException
- no Cookbook
found by
the given Id
NullArgumentException
- procedureReceiver,
cookbookId,
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcedureNotification()
and
supportsVisibleFederation()
are true
ProcedureCookbookSession getProcedureCookbookSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcedureCookbookSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureCookbook()
is false
optional
- This method must be implemented if
supportsProcedureCookbook()
is true.
ProcedureCookbookAssignmentSession getProcedureCookbookAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ProcedureCookbookAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureCookbookAssignment()
is false
optional
- This method must be implemented if
supportsProcedureCookbookAssignment()
is
true.
ProcedureSmartCookbookSession getProcedureSmartCookbookSession(Id cookbookId, Proxy proxy) throws NotFoundException, OperationFailedException
cookbookId
- the Id
of the procedure bookproxy
- a proxy ProcedureSmartCookbookSession
NotFoundException
- procedureBookId
not
foundNullArgumentException
- procedureBookId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcedureSmartCookbook()
is false
optional
- This method must be implemented if
supportsProcedureSmartCookbook()
is true.
CookbookLookupSession getCookbookLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
lookup service.proxy
- a proxy CookbookLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookLookup()
is false
optional
- This method must be implemented if
supportsCookbookLookup()
is true.
CookbookQuerySession getCookbookQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
query service.proxy
- a proxy CookbookQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCookbookQuery()
is false
optional
- This method must be implemented if
supportsCookbookQuery()
is true.
CookbookSearchSession getCookbookSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
search service.proxy
- a proxy CookbookSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookSearch()
is false
optional
- This method must be implemented if
supportsCookbookSearch()
is true.
CookbookAdminSession getCookbookAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
administrative service.proxy
- a proxy CookbookAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCookbookAdmin()
is false
optional
- This method must be implemented if
supportsCookbookAdmin()
is true.
CookbookNotificationSession getCookbookNotificationSession(CookbookReceiver cookbookReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
notification service.cookbookReceiver
- the receiverproxy
- a proxy CookbookNotificationSession
NullArgumentException
- cookbookReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookNotification()
is false
optional
- This method must be implemented if
supportsCookbookNotification()
is true.
CookbookHierarchySession getCookbookHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
hierarchy service.proxy
- a proxy CookbookHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookHierarchy()
is false
optional
- This method must be implemented if
supportsCookbookHierarchy()
is true.
CookbookHierarchyDesignSession getCookbookHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the cook book
hierarchy design service.proxy
- a proxy CookbookHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCookbookHierarchyDesign()
is false
optional
- This method must be implemented if
supportsCookbookHierarchyDesign()
is true.
RecipeBatchProxyManager getRecipeBatchProxyManager() throws OperationFailedException
RecipieBatchProxyManager
. RecipeBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRecipeBatch()
is false
optional
- This method must be implemented if
supportsRecipeBatch()
is true.