Interface CourseChronicleProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CourseChronicleManager, CourseChronicleProxyManager
public interface CourseChronicleProfile extends OsidProfile

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

    • supportsAcademicRecord

      boolean supportsAcademicRecord()
      Tests if retrieving an academic record is supported.
      Returns:
      true if academic record is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramEntryLookup

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

    • supportsProgramEntryQuery

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

    • supportsProgramEntrySearch

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

    • supportsProgramEntryAdmin

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

    • supportsProgramEntryNotification

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

    • supportsProgramEntryCourseCatalog

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

    • supportsProgramEntryCourseCatalogAssignment

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

    • supportsProgramEntrySmartCourseCatalog

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

    • supportsCourseEntryLookup

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

    • supportsCourseEntryQuery

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

    • supportsCourseEntrySearch

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

    • supportsCourseEntryAdmin

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

    • supportsCourseEntryNotification

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

    • supportsCourseEntryCourseCatalog

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

    • supportsCourseEntryCourseCatalogAssignment

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

    • supportsCourseEntrySmartCourseCatalog

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

    • supportsCredentialEntryLookup

      boolean supportsCredentialEntryLookup()
      Tests if looking up credential entries is supported.
      Returns:
      true if credential entry lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCredentialEntryQuery

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

    • supportsCredentialEntrySearch

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

    • supportsCredentialEntryAdmin

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

    • supportsCredentialEntryNotification

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

    • supportsCredentialEntryCourseCatalog

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

    • supportsCredentialEntryCourseCatalogAssignment

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

    • supportsCredentialEntrySmartCourseCatalog

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

    • supportsAssessmentEntryLookup

      boolean supportsAssessmentEntryLookup()
      Tests if looking up assessment entries is supported.
      Returns:
      true if assessment entry lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentEntryQuery

      boolean supportsAssessmentEntryQuery()
      Tests if querying assessment entries is supported.
      Returns:
      true if assessment entry query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentEntrySearch

      boolean supportsAssessmentEntrySearch()
      Tests if searching assessment entries is supported.
      Returns:
      true if assessment entry search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentEntryAdmin

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

    • supportsAssessmentEntryNotification

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

    • supportsAssessmentEntryCourseCatalog

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

    • supportsAssessmentEntryCourseCatalogAssignment

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

    • supportsAssessmentEntrySmartCourseCatalog

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

    • supportsAwardEntryLookup

      boolean supportsAwardEntryLookup()
      Tests if looking up award entries is supported.
      Returns:
      true if award entry lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardEntryQuery

      boolean supportsAwardEntryQuery()
      Tests if querying award entries is supported.
      Returns:
      true if award entry query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardEntrySearch

      boolean supportsAwardEntrySearch()
      Tests if searching award entries is supported.
      Returns:
      true if award entry search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardEntryAdmin

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

    • supportsAwardEntryNotification

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

    • supportsAwardEntryCourseCatalog

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

    • supportsAwardEntryCourseCatalogAssignment

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

    • supportsAwardEntrySmartCourseCatalog

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

    • supportsCourseChronicalBatch

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

    • getProgramEntryRecordTypes

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

    • supportsProgramEntryRecordType

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

    • getProgramEntrySearchRecordTypes

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

    • supportsProgramEntrySearchRecordType

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

    • getCourseEntryRecordTypes

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

    • supportsCourseEntryRecordType

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

    • getCourseEntrySearchRecordTypes

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

    • supportsCourseEntrySearchRecordType

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

    • getCredentialEntryRecordTypes

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

    • supportsCredentialEntryRecordType

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

    • getCredentialEntrySearchRecordTypes

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

    • supportsCredentialEntrySearchRecordType

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

    • getAssessmentEntryRecordTypes

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

    • supportsAssessmentEntryRecordType

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

    • getAssessmentEntrySearchRecordTypes

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

    • supportsAssessmentEntrySearchRecordType

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

    • getAwardEntryRecordTypes

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

    • supportsAwardEntryRecordType

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

    • getAwardEntrySearchRecordTypes

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

    • supportsAwardEntrySearchRecordType

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