Interface CourseProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CourseManager, CourseProxyManager
public interface CourseProfile extends OsidProfile

The course profile describes the interoperability among course management services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsCourseLookup

      boolean supportsCourseLookup()
      Tests if looking up courses is supported.
      Returns:
      true if course lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseQuery

      boolean supportsCourseQuery()
      Tests if querying courses is supported.
      Returns:
      true if course query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseSearch

      boolean supportsCourseSearch()
      Tests if searching courses is supported.
      Returns:
      true if course search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseAdmin

      boolean supportsCourseAdmin()
      Tests if course administrative service is supported.
      Returns:
      true if course administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseNotification

      boolean supportsCourseNotification()
      Tests if a course notification service is supported.
      Returns:
      true if course notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCourseCatalog

      boolean supportsCourseCourseCatalog()
      Tests if a course cataloging service is supported.
      Returns:
      true if course cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCourseCatalogAssignment

      boolean supportsCourseCourseCatalogAssignment()
      Tests if a course cataloging service is supported. A course cataloging service maps courses to catalogs.
      Returns:
      true if course cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseSmartCourseCatalog

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

    • supportsActivityUnitLookup

      boolean supportsActivityUnitLookup()
      Tests if looking up activity units is supported.
      Returns:
      true if activity unit lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitQuery

      boolean supportsActivityUnitQuery()
      Tests if querying activity units is supported.
      Returns:
      true if activity unit query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitSearch

      boolean supportsActivityUnitSearch()
      Tests if searching activity units is supported.
      Returns:
      true if activity unit search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitAdmin

      boolean supportsActivityUnitAdmin()
      Tests if an activity unit administrative service is supported.
      Returns:
      true if activity unit administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitNotification

      boolean supportsActivityUnitNotification()
      Tests if an activity unit notification service is supported.
      Returns:
      true if activity unit notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitCourseCatalog

      boolean supportsActivityUnitCourseCatalog()
      Tests if an activity unit cataloging service is supported.
      Returns:
      true if activity unit catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitCourseCatalogAssignment

      boolean supportsActivityUnitCourseCatalogAssignment()
      Tests if an activity unit cataloging service is supported. A cataloging service maps activity units to catalogs.
      Returns:
      true if activity unit cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitSmartCourseCatalog

      boolean supportsActivityUnitSmartCourseCatalog()
      Tests if an activity unit smart course catalog session is available.
      Returns:
      true if an activity unit smart course catalog session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingLookup

      boolean supportsCourseOfferingLookup()
      Tests if looking up course offerings is supported.
      Returns:
      true if course offering lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingQuery

      boolean supportsCourseOfferingQuery()
      Tests if querying course offerings is supported.
      Returns:
      true if course offering query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingSearch

      boolean supportsCourseOfferingSearch()
      Tests if searching course offerings is supported.
      Returns:
      true if course offering search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingAdmin

      boolean supportsCourseOfferingAdmin()
      Tests if course offering administrative service is supported.
      Returns:
      true if course offering administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingNotification

      boolean supportsCourseOfferingNotification()
      Tests if a course offering notification service is supported.
      Returns:
      true if course offering notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingCourseCatalog

      boolean supportsCourseOfferingCourseCatalog()
      Tests if a course offering cataloging service is supported.
      Returns:
      true if course offering catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingCourseCatalogAssignment

      boolean supportsCourseOfferingCourseCatalogAssignment()
      Tests if a course offering cataloging service is supported. A cataloging service maps course offerings to catalogs.
      Returns:
      true if course offering cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseOfferingSmartCourseCatalog

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

    • supportsActivityLookup

      boolean supportsActivityLookup()
      Tests if looking up activities is supported.
      Returns:
      true if activity lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityQuery

      boolean supportsActivityQuery()
      Tests if querying activities is supported.
      Returns:
      true if activity query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySearch

      boolean supportsActivitySearch()
      Tests if searching activities is supported.
      Returns:
      true if activity search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityAdmin

      boolean supportsActivityAdmin()
      Tests if activity administrative service is supported.
      Returns:
      true if activity administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityNotification

      boolean supportsActivityNotification()
      Tests if an activity notification service is supported.
      Returns:
      true if activity notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityCourseCatalog

      boolean supportsActivityCourseCatalog()
      Tests if an activity cataloging service is supported.
      Returns:
      true if activity catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityCourseCatalogAssignment

      boolean supportsActivityCourseCatalogAssignment()
      Tests if an activity cataloging service is supported. A cataloging service maps activities to catalogs.
      Returns:
      true if activity cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySmartCourseCatalog

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

    • supportsActivityUnravelling

      boolean supportsActivityUnravelling()
      Tests if unravelling activities is supported.
      Returns:
      true if unravelling activities is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermLookup

      boolean supportsTermLookup()
      Tests if looking up terms is supported.
      Returns:
      true if term lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermQuery

      boolean supportsTermQuery()
      Tests if querying terms is supported.
      Returns:
      true if term query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermSearch

      boolean supportsTermSearch()
      Tests if searching terms is supported.
      Returns:
      true if term search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermAdmin

      boolean supportsTermAdmin()
      Tests if term administrative service is supported.
      Returns:
      true if term administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermNotification

      boolean supportsTermNotification()
      Tests if a term notification service is supported.
      Returns:
      true if term notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermHierarchy

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

    • supportsTermHierarchyDesign

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

    • supportsTermCourseCatalog

      boolean supportsTermCourseCatalog()
      Tests if a term cataloging service is supported.
      Returns:
      true if term catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermCourseCatalogAssignment

      boolean supportsTermCourseCatalogAssignment()
      Tests if a term cataloging service is supported. A cataloging service maps terms to catalogs.
      Returns:
      true if term cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermSmartCourseCatalog

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

    • supportsCourseCatalogLookup

      boolean supportsCourseCatalogLookup()
      Tests if looking up course catalogs is supported.
      Returns:
      true if course catalog lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogSearch

      boolean supportsCourseCatalogSearch()
      Tests if searching course catalogs is supported.
      Returns:
      true if course catalog search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if querying course catalogs is supported.
      Returns:
      true if course catalog query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogAdmin

      boolean supportsCourseCatalogAdmin()
      Tests if course catalog administrative service is supported.
      Returns:
      true if course catalog administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogNotification

      boolean supportsCourseCatalogNotification()
      Tests if a course catalog notification service is supported.
      Returns:
      true if course catalog notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogHierarchy

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

    • supportsCourseCatalogHierarchyDesign

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

    • supportsCourseBatch

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

    • supportsCourseProgram

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

    • supportsCourseRegistration

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

    • supportsCourseRequisite

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

    • supportsCourseSyllabus

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

    • supportsCoursePlan

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

    • supportsCourseChronicle

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

    • getCourseRecordTypes

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

    • supportsCourseRecordType

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

    • getCourseSearchRecordTypes

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

    • supportsCourseSearchRecordType

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

    • getActivityUnitRecordTypes

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

    • supportsActivityUnitRecordType

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

    • getActivityUnitSearchRecordTypes

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

    • supportsActivityUnitSearchRecordType

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

    • getCourseOfferingRecordTypes

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

    • supportsCourseOfferingRecordType

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

    • getCourseOfferingSearchRecordTypes

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

    • supportsCourseOfferingSearchRecordType

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

    • getActivityRecordTypes

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

    • supportsActivityRecordType

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

    • getActivitySearchRecordTypes

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

    • supportsActivitySearchRecordType

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

    • getTermRecordTypes

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

    • supportsTermRecordType

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

    • getTermSearchRecordTypes

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

    • supportsTermSearchRecordType

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

    • getCourseCatalogRecordTypes

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

    • supportsCourseCatalogRecordType

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

    • getCourseCatalogSearchRecordTypes

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

    • supportsCourseCatalogSearchRecordType

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