OSID - osid.course.requisite.CourseRequisiteProfile Service Interface Definition

Interface	osid.course.requisite.CourseRequisiteProfile
Implements	`osid.OsidProfile`
Description	The course requisite profile describes the interoperability among course requisite 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	supportsRequisiteLookup
Description	Tests if looking up requisites is supported.
Return	`boolean`		`true` if requisite lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteQuery
Description	Tests if querying requisites is supported.
Return	`boolean`		`true` if requisite query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteSearch
Description	Tests if searching requisites is supported.
Return	`boolean`		`true` if requisite search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteAdmin
Description	Tests if requisite administrative service is supported.
Return	`boolean`		`true` if requisite administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteNotification
Description	Tests if a requisite notification service is supported.
Return	`boolean`		`true` if requisite notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteCourseCatalog
Description	Tests if a requisite cataloging service is supported.
Return	`boolean`		`true` if requisite cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteCourseCatalogAssignment
Description	Tests if a course cataloging service is supported. A course cataloging service maps requisites to catalogs.
Return	`boolean`		`true` if course cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteSmartCourseCatalog
Description	Tests if a requisite smart course catalog session is available.
Return	`boolean`		`true` if a requisite smart course catalog session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteRecordTypes
Description	Gets the supported `Requisite` record types.
Return	`osid.type.TypeList`		a list containing the supported `Requisite` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteRecordType
Description	Tests if the given `Requisite` record type is supported.
Parameters	`osid.type.Type`	`requisiteRecordType`	a `Type` indicating a `Requisite` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`requisiteRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteSearchRecordTypes
Description	Gets the supported `Requisite` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Requisite` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequisiteSearchRecordType
Description	Tests if the given `Requisite` search record type is supported.
Parameters	`osid.type.Type`	`requisiteSearchRecordType`	a `Type` indicating a `Requisite` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`requisiteSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRequirementRecordTypes
Description	Gets the supported `CourseRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `CourseRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRequirementRecordType
Description	Tests if the given `CourseRequirement` record type is supported.
Parameters	`osid.type.Type`	`courseRequirementRecordType`	a `Type` indicating a `CourseRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramRequirementRecordTypes
Description	Gets the supported `ProgramRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `ProgramRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramRequirementRecordType
Description	Tests if the given `ProgramRequirement` record type is supported.
Parameters	`osid.type.Type`	`programRequirementRecordType`	a `Type` indicating a `ProgramRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`programRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialRequirementRecordTypes
Description	Gets the supported `CredentialRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `CredentialRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialRequirementRecordType
Description	Tests if the given `CredentialRequirement` record type is supported.
Parameters	`osid.type.Type`	`credentialRequirementRecordType`	a `Type` indicating a `CredentialRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveRequirementRecordTypes
Description	Gets the supported `LearningObjectiveRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `LearningObjectiveRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveRequirementRecordType
Description	Tests if the given `LearningObjectiveRequirement` record type is supported.
Parameters	`osid.type.Type`	`learningObjectiveRequirementRecordType`	a `Type` indicating a `LearningObjectivelRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`learningObjectiveRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentRequirementRecordTypes
Description	Gets the supported `AsessmentRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `AssessmentRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentRequirementRecordType
Description	Tests if the given `AsessmentRequirement` record type is supported.
Parameters	`osid.type.Type`	`assessmentRequirementRecordType`	a `Type` indicating an `AssessmentRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assessmentRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardRequirementRecordTypes
Description	Gets the supported `AsessmentRequirement` record types.
Return	`osid.type.TypeList`		a list containing the supported `AwardRequirement` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardRequirementRecordType
Description	Tests if the given `AsessmentRequirement` record type is supported.
Parameters	`osid.type.Type`	`awardRequirementRecordType`	a `Type` indicating an `AwardRequirement` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`awardRequirementRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.