Interface CoursePlanProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CoursePlanManager, CoursePlanProxyManager
public interface CoursePlanProfile extends OsidProfile

The course profile describes the interoperability among course services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsPlanLookup

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

    • supportsPlanQuery

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

    • supportsPlanSearch

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

    • supportsPlanAdmin

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

    • supportsPlanNotification

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

    • supportsPlanCourseCatalog

      boolean supportsPlanCourseCatalog()
      Tests if a plan to course catalog lookup session is available.
      Returns:
      true if plan course catalog lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPlanCourseCatalogAssignment

      boolean supportsPlanCourseCatalogAssignment()
      Tests if a plan to course catalog assignment session is available.
      Returns:
      true if plan course catalog assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPlanSmartCourseCatalog

      boolean supportsPlanSmartCourseCatalog()
      Tests if a plan smart course catalog session is available.
      Returns:
      true if plan smart course catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonLookup

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

    • supportsLessonQuery

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

    • supportsLessonSearch

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

    • supportsLessonAdmin

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

    • supportsLessonNotification

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

    • supportsLessonCourseCatalog

      boolean supportsLessonCourseCatalog()
      Tests if a lesson to course catalog lookup session is available.
      Returns:
      true if lesson course catalog lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonCourseCatalogAssignment

      boolean supportsLessonCourseCatalogAssignment()
      Tests if a lesson to course catalog assignment session is available.
      Returns:
      true if lesson course catalog assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonSmartCourseCatalog

      boolean supportsLessonSmartCourseCatalog()
      Tests if a lesson smart course catalog session is available.
      Returns:
      true if lesson smart course catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonConflict

      boolean supportsLessonConflict()
      Tests if looking at lesson conflicts available.
      Returns:
      true if lesson conflict is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonAnchoring

      boolean supportsLessonAnchoring()
      Tests if anchoring lessons is available.
      Returns:
      true if lesson anchoring is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSyllabusRecordTypes

      TypeList getSyllabusRecordTypes()
      Gets the supported Syllabus record types.
      Returns:
      a list containing the supported syllabus record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSyllabusRecordType

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

    • getSyllabusSearchRecordTypes

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

    • supportsSyllabusSearchRecordType

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

    • getPlanRecordTypes

      TypeList getPlanRecordTypes()
      Gets the supported Plan record types.
      Returns:
      a list containing the supported plan record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPlanRecordType

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

    • getPlanSearchRecordTypes

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

    • supportsPlanSearchRecordType

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

    • getLessonRecordTypes

      TypeList getLessonRecordTypes()
      Gets the supported Lesson record types.
      Returns:
      a list containing the supported lesson record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsLessonRecordType

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

    • getLessonSearchRecordTypes

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

    • supportsLessonSearchRecordType

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