Interface CookbookHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CookbookHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Cookbook objects. Each node in the hierarchy is a unique Cookbook . The hierarchy may be traversed recursively to establish the tree structure through getParentCookbooks() and getChildCookbooks() . To relate these Ids to another OSID, getCookbookNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Cookbook available in the Procedure OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentCookbooks() or getChildCookbooks() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessCookbookHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildCookbookIds(Id cookbookId)	Gets the child Ids of the given cookbook.
CookbookList	getChildCookbooks(Id cookbookId)	Gets the child cookbooks of the given id .
Hierarchy	getCookbookHierarchy()	Gets the hierarchy associated with this session.
Id	getCookbookHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCookbookNodeIds(Id cookbookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given cookbook.
CookbookNode	getCookbookNodes(Id cookbookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given cookbook.
IdList	getParentCookbookIds(Id cookbookId)	Gets the parent Ids of the given cookbook.
CookbookList	getParentCookbooks(Id cookbookId)	Gets the parent cookbooks of the given id .
IdList	getRootCookbookIds()	Gets the root cookbook Ids in this hierarchy.
CookbookList	getRootCookbooks()	Gets the root cookbooks in the cookbook hierarchy.
boolean	hasChildCookbooks(Id cookbookId)	Tests if a cookbook has any children.
boolean	hasParentCookbooks(Id cookbookId)	Tests if the Cookbook has any parents.
boolean	isAncestorOfCookbook(Id id, Id cookbookId)	Tests if an Id is an ancestor of a cookbook.
boolean	isChildOfCookbook(Id id, Id cookbookId)	Tests if a cookbook is a direct child of another.
boolean	isDescendantOfCookbook(Id id, Id cookbookId)	Tests if an Id is a descendant of a cookbook.
boolean	isParentOfCookbook(Id id, Id cookbookId)	Tests if an Id is a direct parent of cookbook.
void	useComparativeCookbookView()	The returns from the cookbook methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCookbookView()	A complete view of the Cookbook returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCookbookHierarchyId

Id getCookbookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCookbookHierarchy

Hierarchy getCookbookHierarchy()
                        throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessCookbookHierarchy

boolean canAccessCookbookHierarchy()

Tests if this user can perform hierarchy queries. 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 opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCookbookView

void useComparativeCookbookView()

The returns from the cookbook 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.

getRootCookbookIds

IdList getRootCookbookIds()
                   throws OperationFailedException,
PermissionDeniedException

Gets the root cookbook Ids in this hierarchy.

Returns:

the root cookbook Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootCookbooks

CookbookList getRootCookbooks()
                       throws OperationFailedException,
PermissionDeniedException

Gets the root cookbooks in the cookbook hierarchy. A node with no parents is an orphan. While all cookbook Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root cookbooks

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCookbooks

boolean hasParentCookbooks(Id cookbookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Cookbook has any parents.

Parameters:

cookbookId - a cookbook Id

Returns:

true if the cookbook has parents, f alse otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfCookbook

boolean isParentOfCookbook(Id id,
 Id cookbookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of cookbook.

Parameters:

id - an Id

cookbookId - the Id of a cookbook

Returns:

true if this id is a parent of cookbookId , f alse otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - id or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentCookbookIds

IdList getParentCookbookIds(Id cookbookId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given cookbook.

Parameters:

cookbookId - a cookbook Id

Returns:

the parent Ids of the cookbook

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentCookbooks

CookbookList getParentCookbooks(Id cookbookId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent cookbooks of the given id .

Parameters:

cookbookId - the Id of the Cookbook to query

Returns:

the parent cookbooks of the id

Throws:

NotFoundException - an Cookbook identified by Id is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfCookbook

boolean isAncestorOfCookbook(Id id,
 Id cookbookId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a cookbook.

Parameters:

id - an Id

cookbookId - the Id of a cookbook

Returns:

true if this id is an ancestor of cookbookId , false otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - id or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildCookbooks

boolean hasChildCookbooks(Id cookbookId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a cookbook has any children.

Parameters:

cookbookId - a cookbook Id

Returns:

true if the cookbookId has children, false otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfCookbook

boolean isChildOfCookbook(Id id,
 Id cookbookId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a cookbook is a direct child of another.

Parameters:

id - an Id

cookbookId - the Id of a cookbook

Returns:

true if the id is a child of cookbookId , false otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - id or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildCookbookIds

IdList getChildCookbookIds(Id cookbookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given cookbook.

Parameters:

cookbookId - the Id to query

Returns:

the children of the cookbook

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildCookbooks

CookbookList getChildCookbooks(Id cookbookId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child cookbooks of the given id .

Parameters:

cookbookId - the Id of the Cookbook to query

Returns:

the child cookbooks of the id

Throws:

NotFoundException - an Cookbook identified by Id is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfCookbook

boolean isDescendantOfCookbook(Id id,
 Id cookbookId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a cookbook.

Parameters:

id - an Id

cookbookId - the Id of a cookbook

Returns:

true if the id is a descendant of the cookbookId , false otherwise

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - id or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getCookbookNodeIds

Node getCookbookNodeIds(Id cookbookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given cookbook.

Parameters:

cookbookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a cookbook node

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbookNodes

CookbookNode getCookbookNodes(Id cookbookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given cookbook.

Parameters:

cookbookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a cookbook node

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.