org.osid.checklist.mason

Interface TodoProducerChecklistSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.