Interface CourseProgramProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CourseProgramManager, CourseProgramProxyManager
public interface CourseProgramProfile extends OsidProfile

The course program profile describes the interoperability among course program 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.

    • supportsProgramLookup

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

    • supportsProgramQuery

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

    • supportsProgramSearch

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

    • supportsProgramAdmin

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

    • supportsProgramNotification

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

    • supportsProgramCourseCatalog

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

    • supportsProgramCourseCatalogAssignment

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

    • supportsProgramSmartCourseCatalog

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

    • supportsCourseProgramLookup

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

    • supportsCourseProgramAssignment

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

    • supportsProgramOfferingLookup

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

    • supportsProgramOfferingQuery

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

    • supportsProgramOfferingSearch

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

    • supportsProgramOfferingAdmin

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

    • supportsProgramOfferingNotification

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

    • supportsProgramOfferingCourseCatalog

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

    • supportsProgramOfferingCourseCatalogAssignment

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

    • supportsProgramOfferingSmartCourseCatalog

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

    • supportsCredentialLookup

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

    • supportsCredentialQuery

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

    • supportsCredentialSearch

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

    • supportsCredentialAdmin

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

    • supportsCredentialNotification

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

    • supportsCredentialCourseCatalog

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

    • supportsCredentialCourseCatalogAssignment

      boolean supportsCredentialCourseCatalogAssignment()
      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.

    • supportsCredentialSmartCourseCatalog

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

    • supportsEnrollmentLookup

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

    • supportsEnrollmentQuery

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

    • supportsEnrollmentSearch

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

    • supportsEnrollmentAdmin

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

    • supportsEnrollmentNotification

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

    • supportsEnrollmentCourseCatalog

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

    • supportsEnrollmentCourseCatalogAssignment

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

    • supportsEnrollmentSmartCourseCatalog

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

    • supportsCourseProgramBatch

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

    • getProgramRecordTypes

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

    • supportsProgramRecordType

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

    • getProgramSearchRecordTypes

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

    • supportsProgramSearchRecordType

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

    • getProgramOfferingRecordTypes

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

    • supportsProgramOfferingRecordType

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

    • getProgramOfferingSearchRecordTypes

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

    • supportsProgramOfferingSearchRecordType

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

    • getCredentialRecordTypes

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

    • supportsCredentialRecordType

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

    • getCredentialSearchRecordTypes

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

    • supportsCredentialSearchRecordType

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

    • getEnrollmentRecordTypes

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

    • supportsEnrollmentRecordType

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

    • getEnrollmentSearchRecordTypes

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

    • supportsEnrollmentSearchRecordType

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