OSID - osid.course.plan.CoursePlanProfile Service Interface Definition

Interface	osid.course.plan.CoursePlanProfile
Implements	`osid.OsidProfile`
Description	The course profile describes the interoperability among course services.
Method	supportsVisibleFederation
Description	Tests if any lesson federation is exposed. Federation is exposed when a specific lesson may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of lessonsappears as a single lesson.
Return	`boolean`		`true` if visible federation is supproted, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanLookup
Description	Tests for the availability of a plan lookup service.
Return	`boolean`		`true` if plan lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanQuery
Description	Tests if querying plans is available.
Return	`boolean`		`true` if plan query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanSearch
Description	Tests if searching for plans is available.
Return	`boolean`		`true` if plan search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanAdmin
Description	Tests if searching for plans is available.
Return	`boolean`		`true` if plan search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanNotification
Description	Tests if plan notification is available.
Return	`boolean`		`true` if plan notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanCourseCatalog
Description	Tests if a plan to course catalog lookup session is available.
Return	`boolean`		`true` if plan course catalog lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanCourseCatalogAssignment
Description	Tests if a plan to course catalog assignment session is available.
Return	`boolean`		`true` if plan course catalog assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanSmartCourseCatalog
Description	Tests if a plan smart course catalog session is available.
Return	`boolean`		`true` if plan smart course catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonLookup
Description	Tests for the availability of a lesson lookup service.
Return	`boolean`		`true` if lesson lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonQuery
Description	Tests if querying lessonsis available.
Return	`boolean`		`true` if lesson query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonSearch
Description	Tests if searching for lessons is available.
Return	`boolean`		`true` if lesson search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonAdmin
Description	Tests for the availability of a lesson administrative service for creating and deleting lessons.
Return	`boolean`		`true` if lesson administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonNotification
Description	Tests for the availability of a lesson notification service.
Return	`boolean`		`true` if lesson notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsLessonCourseCatalog
Description	Tests if a lesson to course catalog lookup session is available.
Return	`boolean`		`true` if lesson course catalog lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonCourseCatalogAssignment
Description	Tests if a lesson to course catalog assignment session is available.
Return	`boolean`		`true` if lesson course catalog assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonSmartCourseCatalog
Description	Tests if a lesson smart course catalog session is available.
Return	`boolean`		`true` if lesson smart course catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonConflict
Description	Tests if looking at lesson conflicts available.
Return	`boolean`		`true` if lesson conflict is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonAnchoring
Description	Tests if anchoring lessons is available.
Return	`boolean`		`true` if lesson anchoring is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusRecordTypes
Description	Gets the supported `Syllabus` record types.
Return	`osid.type.TypeList`		a list containing the supported syllabus record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSyllabusRecordType
Description	Tests if the given `Syllabus` record type is supported.
Parameters	`osid.type.Type`	`syllabusRecordType`	a `Type` indicating a `Syllabus` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`syllabusRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusSearchRecordTypes
Description	Gets the supported syllabus search record types.
Return	`osid.type.TypeList`		a list containing the supported syllabus search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSyllabusSearchRecordType
Description	Tests if the given syllabus search record type is supported.
Parameters	`osid.type.Type`	`syllabusSearchRecordType`	a `Type` indicating a syllabus record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`syllabusSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPlanRecordTypes
Description	Gets the supported `Plan` record types.
Return	`osid.type.TypeList`		a list containing the supported plan record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanRecordType
Description	Tests if the given `Plan` record type is supported.
Parameters	`osid.type.Type`	`planRecordType`	a `Type` indicating a `Plan` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`planRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPlanSearchRecordTypes
Description	Gets the supported plan search record types.
Return	`osid.type.TypeList`		a list containing the supported plan search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanSearchRecordType
Description	Tests if the given plan search record type is supported.
Parameters	`osid.type.Type`	`planSearchRecordType`	a `Type` indicating a plan record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`planSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonRecordTypes
Description	Gets the supported `Lesson` record types.
Return	`osid.type.TypeList`		a list containing the supported lesson record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonRecordType
Description	Tests if the given `Lesson` record type is supported.
Parameters	`osid.type.Type`	`lessonRecordType`	a `Type` indicating a `Lesson` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonSearchRecordTypes
Description	Gets the supported lesson search record types.
Return	`osid.type.TypeList`		a list containing the supported lesson search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonSearchRecordType
Description	Tests if the given lesson search record type is supported.
Parameters	`osid.type.Type`	`lessonSearchRecordType`	a `Type` indicating a lesson record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`lessonSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.