org.osid.checklist.mason

Interface TodoProducerSmartChecklistSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface TodoProducerSmartChecklistSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic checklists. A TodoProducerQuery can be retrieved from this session and mapped to this Checklist to create a virtual collection of todo producers. The todo producers may be sequenced using the TodoProducerSearchOrder from this session.

This Checklist has a default query that matches any todo producer and a default search order that specifies no sequencing. The queries may be examined using a TodoProducerQueryInspector. The query may be modified by converting the inspector back to a TodoProducerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTodoProducerQuery(TodoProducerQuery todoProducerQuery) Applies a todo producer query to this checklist.
void	applyTodoProducerSequencing(TodoProducerSearchOrder todoProducerSearchOrder) Applies a todo producer search order to this checklist.
boolean	canManageSmartChecklists() Tests if this user can manage smart checklists.
Checklist	getChecklist() Gets the Checklist associated with this session.
Id	getChecklistId() Gets the Checklist Id associated with this session.
TodoProducerQuery	getTodoProducerQuery() Gets a todo producer query.
TodoProducerQuery	getTodoProducerQueryFromInspector(TodoProducerQueryInspector todoProducerQueryInspector) Gets a todo producer query from an inspector.
TodoProducerSearchOrder	getTodoProducerSearchOrder() Gets a todo producer search order.
TodoProducerQueryInspector	inspectTodoProducerQuery() Gets a todo producer query inspector for this checklist.

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

getChecklistId

Id getChecklistId()

Gets the Checklist Id associated with this session.

Returns:

the Checklist Id associated with this session

Compliance:

mandatory - This method must be implemented.

getChecklist

Checklist getChecklist()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Checklist associated with this session.

Returns:

the checklist

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartChecklists

boolean canManageSmartChecklists()

Tests if this user can manage smart checklists. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart checklist management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getTodoProducerQuery

TodoProducerQuery getTodoProducerQuery()

Gets a todo producer query.

Returns:

the todo producer query

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchOrder

TodoProducerSearchOrder getTodoProducerSearchOrder()

Gets a todo producer search order.

Returns:

the todo producer search order

Compliance:

mandatory - This method must be implemented.

applyTodoProducerQuery

void applyTodoProducerQuery(TodoProducerQuery todoProducerQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a todo producer query to this checklist.

Parameters:

todoProducerQuery - the todo producer query

Throws:

NullArgumentException - todoProducerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - todoProducerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectTodoProducerQuery

TodoProducerQueryInspector inspectTodoProducerQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a todo producer query inspector for this checklist.

Returns:

the todo producer query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyTodoProducerSequencing

void applyTodoProducerSequencing(TodoProducerSearchOrder todoProducerSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a todo producer search order to this checklist.

Parameters:

todoProducerSearchOrder - the todo producer search order

Throws:

NullArgumentException - todoProducerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - todoProducerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getTodoProducerQueryFromInspector

TodoProducerQuery getTodoProducerQueryFromInspector(TodoProducerQueryInspector todoProducerQueryInspector)

Gets a todo producer query from an inspector.

Parameters:

todoProducerQueryInspector - a todo producer query inspector

Returns:

the todo producer query

Throws:

NullArgumentException - todoProducerQueryInspector is null

UnsupportedException - todoProducerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.