Interface TodoSmartChecklistSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface TodoSmartChecklistSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A TodoQuery can be retrieved from this session and mapped to this Checklist to create a virtual collection of Todos . The todos may be sequenced using the TodoSearchOrder from this session.

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

  • Method Details

    • 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 associated with this session
      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.

    • getTodoQuery

      TodoQuery getTodoQuery()
      Gets a todo query.
      Returns:
      the todo query
      Compliance:
      mandatory - This method must be implemented.

    • getTodoSearchOrder

      TodoSearchOrder getTodoSearchOrder()
      Gets a todo search order.
      Returns:
      the todo search order
      Compliance:
      mandatory - This method must be implemented.

    • applyTodoQuery

      void applyTodoQuery(TodoQuery todoQuery) throws OperationFailedException, PermissionDeniedException
      Applies a todo query to this checklist.
      Parameters:
      todoQuery - the todo query
      Throws:
      NullArgumentException - todoQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - todoQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectTodoQuery

      TodoQueryInspector inspectTodoQuery() throws OperationFailedException, PermissionDeniedException
      Gets a todo query inspector for this checklist.
      Returns:
      the todo query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyTodoSequencing

      void applyTodoSequencing(TodoSearchOrder todoSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a todo search order to this checklist.
      Parameters:
      todoSearchOrder - the todo search order
      Throws:
      NullArgumentException - todoSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - todoSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getTodoQueryFromInspector

      TodoQuery getTodoQueryFromInspector(TodoQueryInspector todoQueryInspector)
      Gets a todo query from an inspector.
      Parameters:
      todoQueryInspector - a query inspector
      Returns:
      the todo query
      Throws:
      NullArgumentException - todoQueryInspector is null
      UnsupportedException - todoQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.