OSID - osid.course.chronicle.CourseChronicleProfile Service Interface Definition

Interface	osid.course.chronicle.CourseChronicleProfile
Implements	`osid.OsidProfile`
Description	The course chronicle profile describes the interoperability among course chronicle services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademicRecord
Description	Tests if retrieving an academic record is supported.
Return	`boolean`		`true` if academic record is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryLookup
Description	Tests if looking up program entries is supported.
Return	`boolean`		`true` if program entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryQuery
Description	Tests if querying program entries is supported.
Return	`boolean`		`true` if program entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntrySearch
Description	Tests if searching program entries is supported.
Return	`boolean`		`true` if program entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryAdmin
Description	Tests if program entry administrative service is supported.
Return	`boolean`		`true` if program entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryNotification
Description	Tests if a program entry notification service is supported.
Return	`boolean`		`true` if program entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryCourseCatalog
Description	Tests if a program entry cataloging service is supported.
Return	`boolean`		`true` if program entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps program entries to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntrySmartCourseCatalog
Description	Tests if a program entry smart course catalog session is available.
Return	`boolean`		`true` if a program entry smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryLookup
Description	Tests if looking up course entries is supported.
Return	`boolean`		`true` if course entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryQuery
Description	Tests if querying course entries is supported.
Return	`boolean`		`true` if course entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntrySearch
Description	Tests if searching course entries is supported.
Return	`boolean`		`true` if course entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryAdmin
Description	Tests if course entry administrative service is supported.
Return	`boolean`		`true` if course entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryNotification
Description	Tests if a course entry notification service is supported.
Return	`boolean`		`true` if course entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryCourseCatalog
Description	Tests if a course entry cataloging service is supported.
Return	`boolean`		`true` if course entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps course entries to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntrySmartCourseCatalog
Description	Tests if a course entry smart course catalog session is available.
Return	`boolean`		`true` if a course entry smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryLookup
Description	Tests if looking up credential entries is supported.
Return	`boolean`		`true` if credential entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryQuery
Description	Tests if querying credential entries is supported.
Return	`boolean`		`true` if credential entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntrySearch
Description	Tests if searching credential entries is supported.
Return	`boolean`		`true` if credential entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryAdmin
Description	Tests if credential entry administrative service is supported.
Return	`boolean`		`true` if credential entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryNotification
Description	Tests if a credential entry notification service is supported.
Return	`boolean`		`true` if credential entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryCourseCatalog
Description	Tests if a credential entry cataloging service is supported.
Return	`boolean`		`true` if credential entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps credential entries to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntrySmartCourseCatalog
Description	Tests if a credential entry smart course catalog session is available.
Return	`boolean`		`true` if a credential entry smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryLookup
Description	Tests if looking up assessment entries is supported.
Return	`boolean`		`true` if assessment entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryQuery
Description	Tests if querying assessment entries is supported.
Return	`boolean`		`true` if assessment entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntrySearch
Description	Tests if searching assessment entries is supported.
Return	`boolean`		`true` if assessment entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryAdmin
Description	Tests if assessment entry administrative service is supported.
Return	`boolean`		`true` if assessment entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryNotification
Description	Tests if an assessment entry notification service is supported.
Return	`boolean`		`true` if assessment entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryCourseCatalog
Description	Tests if an assessment entry cataloging service is supported.
Return	`boolean`		`true` if assessment entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps assessment entries to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntrySmartCourseCatalog
Description	Tests if an assessment entry smart course catalog session is available.
Return	`boolean`		`true` if an assessment entry smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryLookup
Description	Tests if looking up award entries is supported.
Return	`boolean`		`true` if award entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryQuery
Description	Tests if querying award entries is supported.
Return	`boolean`		`true` if award entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntrySearch
Description	Tests if searching award entries is supported.
Return	`boolean`		`true` if award entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryAdmin
Description	Tests if award entry administrative service is supported.
Return	`boolean`		`true` if award entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryNotification
Description	Tests if an award entry notification service is supported.
Return	`boolean`		`true` if award entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryCourseCatalog
Description	Tests if an award entry cataloging service is supported.
Return	`boolean`		`true` if award entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps award entries to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntrySmartCourseCatalog
Description	Tests if an award entry smart course catalog session is available.
Return	`boolean`		`true` if an award entry smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseChronicalBatch
Description	Tests if a course chronicle batch service is available.
Return	`boolean`		`true` if a course chronicle batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryRecordTypes
Description	Gets the supported `ProgramEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `ProgramEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntryRecordType
Description	Tests if the given `ProgramEntry` record type is supported.
Parameters	`osid.type.Type`	`programEntryRecordType`	a `Type` indicating a `ProgramEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntrySearchRecordTypes
Description	Gets the supported `ProgramEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ProgramEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramEntrySearchRecordType
Description	Tests if the given `ProgramEntry` search record type is supported.
Parameters	`osid.type.Type`	`programEntrySearchRecordType`	a `Type` indicating a `ProgramEntry` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryRecordTypes
Description	Gets the supported `CourseEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntryRecordType
Description	Tests if the given `CourseEntry` record type is supported.
Parameters	`osid.type.Type`	`courseEntryRecordType`	a `Type` indicating a `CourseEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntrySearchRecordTypes
Description	Gets the supported `CourseEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseEntrySearchRecordType
Description	Tests if the given `CourseEntry` search record type is supported.
Parameters	`osid.type.Type`	`courseEntrySearchRecordType`	a `Type` indicating a `CourseEntry` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryRecordTypes
Description	Gets the supported `CredentialEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `CredentialEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntryRecordType
Description	Tests if the given `CredentialEntry` record type is supported.
Parameters	`osid.type.Type`	`credentialEntryRecordType`	a `Type` indicating a `CredentialEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntrySearchRecordTypes
Description	Gets the supported `CredentialEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CredentialEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialEntrySearchRecordType
Description	Tests if the given `CredentialEntry` search record type is supported.
Parameters	`osid.type.Type`	`credentialEntrySearchRecordType`	a `Type` indicating a `CredentialEntry` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntryRecordTypes
Description	Gets the supported `AssessmentEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `AssessmentEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntryRecordType
Description	Tests if the given `AssessmentEntry` record type is supported.
Parameters	`osid.type.Type`	`assessmentEntryRecordType`	an `Type` indicating an `AssessmentEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntrySearchRecordTypes
Description	Gets the supported `AssessmentEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `AssessmentEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentEntrySearchRecordType
Description	Tests if the given `AssessmentEntry` search record type is supported.
Parameters	`osid.type.Type`	`assessmentEntrySearchRecordType`	an `Type` indicating an `AssessmentEntry` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryRecordTypes
Description	Gets the supported `AwardEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `AwardEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntryRecordType
Description	Tests if the given `AwardEntry` record type is supported.
Parameters	`osid.type.Type`	`awardEntryRecordType`	an `Type` indicating an `AwardEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntrySearchRecordTypes
Description	Gets the supported `AwardEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `AwardEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardEntrySearchRecordType
Description	Tests if the given `AwardEntry` search record type is supported.
Parameters	`osid.type.Type`	`awardEntrySearchRecordType`	an `Type` indicating an `AwardEntry` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.