Interface ChecklistLookupSession

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

This session provides methods for retrieving Checklists . The Checklist represents a collection of todos.

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

  • Method Details

    • canLookupChecklists

      boolean canLookupChecklists()
      Tests if this user can perform Checklist 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeChecklistView

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

    • usePlenaryChecklistView

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

    • getChecklist

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

    • getChecklistsByIds

      ChecklistList getChecklistsByIds(IdList checklistIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ChecklistList corresponding to the given IdList . In plenary mode, the returned list contains all of the checklists 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 Checklists may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      checklistIds - the list of Ids to retrieve
      Returns:
      the returned Checklist list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - checklistIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecklistsByGenusType

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

    • getChecklistsByParentGenusType

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

    • getChecklistsByRecordType

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

    • getChecklistsByProvider

      ChecklistList getChecklistsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a ChecklistList from the given provider. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.
      Parameters:
      resourceId - a provider Id
      Returns:
      the returned Checklist list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecklists

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