Interface ChecklistProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ChecklistManager, ChecklistProxyManager
public interface ChecklistProfile extends OsidProfile

The todoing profile describes the interoperability among todoing services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any checklist federation is exposed. Federation is exposed when a specific checklist may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of checklists appears as a single checklist.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoLookup

      boolean supportsTodoLookup()
      Tests for the availability of a todo lookup service.
      Returns:
      true if todo lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoQuery

      boolean supportsTodoQuery()
      Tests if querying todos is available.
      Returns:
      true if todo query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoSearch

      boolean supportsTodoSearch()
      Tests if searching for todos is available.
      Returns:
      true if todo search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoAdmin

      boolean supportsTodoAdmin()
      Tests if managing todos is available.
      Returns:
      true if todo admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoNotification

      boolean supportsTodoNotification()
      Tests if todo notification is available.
      Returns:
      true if todo notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoHierarchy

      boolean supportsTodoHierarchy()
      Tests if todo hierarchy traversal service is supported.
      Returns:
      true if todo hierarchy is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoHierarchyDesign

      boolean supportsTodoHierarchyDesign()
      Tests if a todo hierarchy design service is supported.
      Returns:
      true if todo hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoChecklist

      boolean supportsTodoChecklist()
      Tests if a todo to checklist lookup session is available.
      Returns:
      true if todo checklist lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoChecklistAssignment

      boolean supportsTodoChecklistAssignment()
      Tests if a todo to checklist assignment session is available.
      Returns:
      true if todo checklist assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoSmartChecklist

      boolean supportsTodoSmartChecklist()
      Tests if a todo smart checklisting session is available.
      Returns:
      true if todo smart checklisting is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistLookup

      boolean supportsChecklistLookup()
      Tests for the availability of a checklist lookup service.
      Returns:
      true if checklist lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistQuery

      boolean supportsChecklistQuery()
      Tests if querying checklists is available.
      Returns:
      true if checklist query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistSearch

      boolean supportsChecklistSearch()
      Tests if searching for checklists is available.
      Returns:
      true if checklist search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistAdmin

      boolean supportsChecklistAdmin()
      Tests for the availability of a checklist administrative service for creating and deleting checklists.
      Returns:
      true if checklist administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistNotification

      boolean supportsChecklistNotification()
      Tests for the availability of a checklist notification service.
      Returns:
      true if checklist notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsChecklistHierarchy

      boolean supportsChecklistHierarchy()
      Tests for the availability of a checklist hierarchy traversal service.
      Returns:
      true if checklist hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistHierarchyDesign

      boolean supportsChecklistHierarchyDesign()
      Tests for the availability of a checklist hierarchy design service.
      Returns:
      true if checklist hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsChecklistBatch

      boolean supportsChecklistBatch()
      Tests for the availability of a checklist batch service.
      Returns:
      true if checklist batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsChecklistMason

      boolean supportsChecklistMason()
      Tests for the availability of a checklist mason service.
      Returns:
      true if checklist mason service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getTodoRecordTypes

      TypeList getTodoRecordTypes()
      Gets the supported Todo record types.
      Returns:
      a list containing the supported todo record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoRecordType

      boolean supportsTodoRecordType(Type todoRecordType)
      Tests if the given Todo record type is supported.
      Parameters:
      todoRecordType - a Type indicating a Todo record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - todoRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getTodoSearchRecordTypes

      TypeList getTodoSearchRecordTypes()
      Gets the supported todo search record types.
      Returns:
      a list containing the supported todo search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsTodoSearchRecordType

      boolean supportsTodoSearchRecordType(Type todoSearchRecordType)
      Tests if the given todo search record type is supported.
      Parameters:
      todoSearchRecordType - a Type indicating a todo record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - todoSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getChecklistRecordTypes

      TypeList getChecklistRecordTypes()
      Gets the supported Checklist record types.
      Returns:
      a list containing the supported checklist record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistRecordType

      boolean supportsChecklistRecordType(Type checklistRecordType)
      Tests if the given Checklist record type is supported.
      Parameters:
      checklistRecordType - a Type indicating a Checklist record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - checklistRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getChecklistSearchRecordTypes

      TypeList getChecklistSearchRecordTypes()
      Gets the supported checklist search record types.
      Returns:
      a list containing the supported checklist search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsChecklistSearchRecordType

      boolean supportsChecklistSearchRecordType(Type checklistSearchRecordType)
      Tests if the given checklist search record type is supported.
      Parameters:
      checklistSearchRecordType - a Type indicating a checklist record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - checklistSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriorityTypes

      TypeList getPriorityTypes()
      Gets the supported priority types.
      Returns:
      a list containing the supported priority types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriorityType

      boolean supportsPriorityType(Type priorityType)
      Tests if the given priority type is supported.
      Parameters:
      priorityType - a Type indicating a priority type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - priorityType is null
      Compliance:
      mandatory - This method must be implemented.