Interface CourseSyllabusProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CourseSyllabusManager, CourseSyllabusProxyManager
public interface CourseSyllabusProfile extends OsidProfile

The course profile describes the interoperability among course services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsSyllabusLookup

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

    • supportsSyllabusQuery

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

    • supportsSyllabusSearch

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

    • supportsSyllabusAdmin

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

    • supportsSyllabusNotification

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

    • supportsSyllabusCourseCatalog

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

    • supportsSyllabusCourseCatalogAssignment

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

    • supportsSyllabusSmartCourseCatalog

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

    • supportsModule

      boolean supportsModule()
      Tests for the availability of a module service for getting available modules for a resource.
      Returns:
      true if module is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModuleLookup

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

    • supportsModuleQuery

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

    • supportsModuleSearch

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

    • supportsModuleAdmin

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

    • supportsModuleNotification

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

    • supportsModuleCourseCatalog

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

    • supportsModuleCourseCatalogAssignment

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

    • supportsModuleSmartCourseCatalog

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

    • supportsDocetLookup

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

    • supportsDocetQuery

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

    • supportsDocetSearch

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

    • supportsDocetAdmin

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

    • supportsDocetNotification

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

    • supportsDocetCourseCatalog

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

    • supportsDocetCourseCatalogAssignment

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

    • supportsDocetSmartCourseCatalog

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

    • supportsCourseSyllabusBatch

      boolean supportsCourseSyllabusBatch()
      Tests if a course syllabus batch service is available.
      Returns:
      true if a course syllabus batch service is supported, 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.

    • getModuleRecordTypes

      TypeList getModuleRecordTypes()
      Gets the supported Module record types.
      Returns:
      a list containing the supported module record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsModuleRecordType

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

    • getModuleSearchRecordTypes

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

    • supportsModuleSearchRecordType

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

    • getDocetRecordTypes

      TypeList getDocetRecordTypes()
      Gets the supported Docet record types.
      Returns:
      a list containing the supported docet record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDocetRecordType

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

    • getDocetSearchRecordTypes

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

    • supportsDocetSearchRecordType

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