Interface ProcedureCookbookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcedureCookbookSession
extends OsidSession

This session provides methods to retrieve Procedure to Cookbook mappings. A Procedure may appear in multiple Cookbooks . Each Cookbook may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupProcedureCookbookMappings()	Tests if this user can perform lookups of procedure/cookbook mappings.
IdList	getCookbookIdsByProcedure(Id procedureId)	Gets the list of Cookbook Ids mapped to a Procedure .
CookbookList	getCookbooksByProcedure(Id procedureId)	Gets the list of Cookbook objects mapped to a Procedure .
IdList	getProcedureIdsByCookbook(Id cookbookId)	Gets the list of Procedure Ids associated with an Cookbook .
IdList	getProcedureIdsByCookbooks(IdList cookbookIds)	Gets the list of Procedure Ids corresponding to a list of Cookbook objects.
ProcedureList	getProceduresByCookbook(Id cookbookId)	Gets the list of Procedures associated with an Cookbook .
ProcedureList	getProceduresByCookbooks(IdList cookbookIds)	Gets the list of Procedures corresponding to a list of Cookbooks .
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.
void	usePlenaryCookbookView()	A complete view of the Procedure and 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

canLookupProcedureCookbookMappings

boolean canLookupProcedureCookbookMappings()

Tests if this user can perform lookups of procedure/cookbook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is 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 Procedure and 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.

getProcedureIdsByCookbook

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

Gets the list of Procedure Ids associated with an Cookbook .

Parameters:

cookbookId - Id of an Cookbook .

Returns:

list of related procedure Ids

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.

getProceduresByCookbook

ProcedureList getProceduresByCookbook(Id cookbookId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Procedures associated with an Cookbook .

Parameters:

cookbookId - Id of an Cookbook

Returns:

list of related procedures

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.

getProcedureIdsByCookbooks

IdList getProcedureIdsByCookbooks(IdList cookbookIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Procedure Ids corresponding to a list of Cookbook objects.

Parameters:

cookbookIds - list of cookbook Ids

Returns:

list of procedure Ids

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProceduresByCookbooks

ProcedureList getProceduresByCookbooks(IdList cookbookIds)
                                throws OperationFailedException,
PermissionDeniedException

Gets the list of Procedures corresponding to a list of Cookbooks .

Parameters:

cookbookIds - list of cookbook Ids

Returns:

list of procedures

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbookIdsByProcedure

IdList getCookbookIdsByProcedure(Id procedureId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Cookbook Ids mapped to a Procedure .

Parameters:

procedureId - Id of a Procedure

Returns:

list of cookbook Ids

Throws:

NotFoundException - procedureId is not found

NullArgumentException - procedureId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbooksByProcedure

CookbookList getCookbooksByProcedure(Id procedureId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Cookbook objects mapped to a Procedure .

Parameters:

procedureId - Id of a Procedure

Returns:

list of cookbooks

Throws:

NotFoundException - procedureId is not found

NullArgumentException - procedureId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.