Interface TodoProducerLookupSession

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

This session provides methods for retrieving TodoProducers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated checklist view: All todo producer methods in this session operate, retrieve and pertain to todo producers defined explicitly in the current checklist. Using an isolated view is useful for managing TodoProducers with the TodoProducerAdminSession .
  • federated checklist view: All todo producer methods in this session operate, retrieve and pertain to all todo producers defined in this checklist and any other todo producers implicitly available in this checklist through checklist inheritence.
  • active todo producer view: All todo producer lookup methods return active todo producers.
  • any status todo producer view: todo producers of any active and inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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.

    • canLookupTodoProducers

      boolean canLookupTodoProducers()
      Tests if this user can perform TodoProducers 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeTodoProducerView

      void useComparativeTodoProducerView()
      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.

    • usePlenaryTodoProducerView

      void usePlenaryTodoProducerView()
      A complete view of the TodoProducer 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.

    • 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 checklist 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.

    • useActiveTodoProducerView

      void useActiveTodoProducerView()
      Only active todo producers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusTodoProducerView

      void useAnyStatusTodoProducerView()
      All active and inactive todo producers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getTodoProducer

      TodoProducer getTodoProducer(Id todoProducerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the TodoProducer specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned TodoProducer may have a different Id than requested, such as the case where a duplicate Id was assigned to a TodoProducer and retained for compatibility.
      Parameters:
      todoProducerId - Id of the TodoProducer
      Returns:
      the todo producer
      Throws:
      NotFoundException - todoProducerId not found
      NullArgumentException - todoProducerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getTodoProducersByIds

      TodoProducerList getTodoProducersByIds(IdList todoProducerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a TodoProducerList corresponding to the given IdList .In plenary mode, the returned list contains all of the todo producers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TodoProducers may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      todoProducerIds - the list of Ids to retrieve
      Returns:
      the returned TodoProducer list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - todoProducerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducersByGenusType

      TodoProducerList getTodoProducersByGenusType(Type todoProducerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a TodoProducerList corresponding to the given todo producer genus Type which does not include todo producers of genus types derived from the specified Type . In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
      Parameters:
      todoProducerGenusType - a todo producer genus type
      Returns:
      the returned TodoProducer list
      Throws:
      NullArgumentException - todoProducerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducersByParentGenusType

      TodoProducerList getTodoProducersByParentGenusType(Type todoProducerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a TodoProducerList corresponding to the given todo producer genus Type and include any additional todo producers with genus types derived from the specified Type . In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
      Parameters:
      todoProducerGenusType - a todo producer genus type
      Returns:
      the returned TodoProducer list
      Throws:
      NullArgumentException - todoProducerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducersByRecordType

      TodoProducerList getTodoProducersByRecordType(Type todoProducerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a TodoProducerList containing the given todo producer record Type .In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
      Parameters:
      todoProducerRecordType - a todo producer record type
      Returns:
      the returned TodoProducer list
      Throws:
      NullArgumentException - todoProducerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducerByTodo

      TodoProducer getTodoProducerByTodo(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a TodoProducer by Todo . In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
      Parameters:
      todoId - a todo Id
      Returns:
      the returned TodoProducer
      Throws:
      InvalidArgumentException - from is greater than to
      NotFoundException - todoId is not found or has no producer
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTodoProducers

      TodoProducerList getTodoProducers() throws OperationFailedException, PermissionDeniedException
      Gets all TodoProducers . In plenary mode, the returned list contains all known todo producers or an error results. Otherwise, the returned list may contain only those todo producers that are accessible through this session.
      Returns:
      the returned TodoProducer list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.