Interface TodoProducerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
TodoProducerSearchSession
public interface TodoProducerQuerySession extends OsidSession

This session provides methods for searching among TodoProducers. The search query is constructed using the TodoProducerQuery.

This session defines views that offer differing behaviors for searching.

  • federated checklist view: searches include todo producers in checklists of which this checklist is an ancestor in the checklist hierarchy
  • isolated checklist view: searches are restricted to todo producers in this checklist

Todo producers may have a query record indicated by their respective record types. The query record is accessed via the TodoProducerQuery.

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchTodoProducers

      boolean canSearchTodoProducers()
      Tests if this user can perform TodoProducer lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedChecklistView

      void useFederatedChecklistView()
      Federates the view for methods in this session. A federated view will include todo producers in checklists which are children of this broker in the checklist hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedChecklistView

      void useIsolatedChecklistView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this checklist only.
      Compliance:
      mandatory - This method is must be implemented.

    • getTodoProducerQuery

      TodoProducerQuery getTodoProducerQuery()
      Gets a todo producer query.
      Returns:
      the todo producer query
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducersByQuery

      TodoProducerList getTodoProducersByQuery(TodoProducerQuery todoProducerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of TodoProducers matching the given todo producer query.
      Parameters:
      todoProducerQuery - the todo producer query
      Returns:
      the returned TodoProducerList
      Throws:
      NullArgumentException - todoProducerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - todoProducerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.