Interface TodoProducerChecklistSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TodoProducerChecklistSession
extends OsidSession

This session provides methods to retrieve TodoProducer to Checklist mappings. A TodoProducer may appear in multiple Checklist objects. Each checklist 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	canLookupTodoProducerChecklistMappings()	Tests if this user can perform lookups of todo producer/checklist mappings.
IdList	getChecklistIdsByTodoProducer(Id todoProducerId)	Gets the Checklist Ids mapped to a TodoProducer .
ChecklistList	getChecklistsByTodoProducer(Id todoProducerId)	Gets the Checklists mapped to a TodoProducer .
IdList	getTodoProducerIdsByChecklist(Id checklistId)	Gets the list of TodoProducerIds associated with an Checklist .
IdList	getTodoProducerIdsByChecklists(IdList checklistIds)	Gets the list of TodoProducer Ids corresponding to a list of Checklists .
TodoProducerList	getTodoProducersByChecklist(Id checklistId)	Gets the list of todo producers associated with an Checklist .
TodoProducerList	getTodoProducersByChecklists(IdList checklistIds)	Gets the list of todo producers corresponding to a list of Checklists .
void	useComparativeTodoProducerChecklistView()	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	usePlenaryTodoProducerChecklistView()	A complete view of the TodoProducer and Checklist 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

canLookupTodoProducerChecklistMappings

boolean canLookupTodoProducerChecklistMappings()

Tests if this user can perform lookups of todo producer/checklist 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 intended as 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.

useComparativeTodoProducerChecklistView

void useComparativeTodoProducerChecklistView()

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.

usePlenaryTodoProducerChecklistView

void usePlenaryTodoProducerChecklistView()

A complete view of the TodoProducer and Checklist 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.

getTodoProducerIdsByChecklist

IdList getTodoProducerIdsByChecklist(Id checklistId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of TodoProducerIds associated with an Checklist .

Parameters:

checklistId - Id of the Checklist

Returns:

list of related todo producer Ids

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoProducersByChecklist

TodoProducerList getTodoProducersByChecklist(Id checklistId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of todo producers associated with an Checklist .

Parameters:

checklistId - Id of the Checklist

Returns:

list of related todo producers

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoProducerIdsByChecklists

IdList getTodoProducerIdsByChecklists(IdList checklistIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of TodoProducer Ids corresponding to a list of Checklists .

Parameters:

checklistIds - list of checklist Ids

Returns:

list of todo producer Ids

Throws:

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoProducersByChecklists

TodoProducerList getTodoProducersByChecklists(IdList checklistIds)
                                       throws OperationFailedException,
PermissionDeniedException

Gets the list of todo producers corresponding to a list of Checklists .

Parameters:

checklistIds - list of checklist Ids

Returns:

list of todo producers

Throws:

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecklistIdsByTodoProducer

IdList getChecklistIdsByTodoProducer(Id todoProducerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Checklist Ids mapped to a TodoProducer .

Parameters:

todoProducerId - Id of a TodoProducer

Returns:

list of checklists

Throws:

NotFoundException - todoProducerId is not found

NullArgumentException - todoProducerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecklistsByTodoProducer

ChecklistList getChecklistsByTodoProducer(Id todoProducerId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Checklists mapped to a TodoProducer .

Parameters:

todoProducerId - Id of a TodoProducer

Returns:

list of checklists

Throws:

NotFoundException - todoProducerId is not found

NullArgumentException - todoProducerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.