public interface CoursePlanProfile extends OsidProfile
The course profile describes the interoperability among course services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getLessonRecordTypes()
Gets the supported
Lesson record types. |
TypeList |
getLessonSearchRecordTypes()
Gets the supported lesson search record types.
|
TypeList |
getPlanRecordTypes()
Gets the supported
Plan record types. |
TypeList |
getPlanSearchRecordTypes()
Gets the supported plan search record types.
|
TypeList |
getSyllabusRecordTypes()
Gets the supported
Syllabus record types. |
TypeList |
getSyllabusSearchRecordTypes()
Gets the supported syllabus search record types.
|
boolean |
supportsLessonAdmin()
Tests for the availability of a lesson administrative service for
creating and deleting lessons.
|
boolean |
supportsLessonAnchoring()
Tests if anchoring lessons is available.
|
boolean |
supportsLessonConflict()
Tests if looking at lesson conflicts available.
|
boolean |
supportsLessonCourseCatalog()
Tests if a lesson to course catalog lookup session is available.
|
boolean |
supportsLessonCourseCatalogAssignment()
Tests if a lesson to course catalog assignment session is available.
|
boolean |
supportsLessonLookup()
Tests for the availability of a lesson lookup service.
|
boolean |
supportsLessonNotification()
Tests for the availability of a lesson notification service.
|
boolean |
supportsLessonQuery()
Tests if querying lessonsis available.
|
boolean |
supportsLessonRecordType(Type lessonRecordType)
Tests if the given
Lesson record type is supported. |
boolean |
supportsLessonSearch()
Tests if searching for lessons is available.
|
boolean |
supportsLessonSearchRecordType(Type lessonSearchRecordType)
Tests if the given lesson search record type is supported.
|
boolean |
supportsLessonSmartCourseCatalog()
Tests if a lesson smart course catalog session is available.
|
boolean |
supportsPlanAdmin()
Tests if searching for plans is available.
|
boolean |
supportsPlanCourseCatalog()
Tests if a plan to course catalog lookup session is available.
|
boolean |
supportsPlanCourseCatalogAssignment()
Tests if a plan to course catalog assignment session is available.
|
boolean |
supportsPlanLookup()
Tests for the availability of a plan lookup service.
|
boolean |
supportsPlanNotification()
Tests if plan notification is available.
|
boolean |
supportsPlanQuery()
Tests if querying plans is available.
|
boolean |
supportsPlanRecordType(Type planRecordType)
Tests if the given
Plan record type is supported. |
boolean |
supportsPlanSearch()
Tests if searching for plans is available.
|
boolean |
supportsPlanSearchRecordType(Type planSearchRecordType)
Tests if the given plan search record type is supported.
|
boolean |
supportsPlanSmartCourseCatalog()
Tests if a plan smart course catalog session is available.
|
boolean |
supportsSyllabusRecordType(Type syllabusRecordType)
Tests if the given
Syllabus record type is supported. |
boolean |
supportsSyllabusSearchRecordType(Type syllabusSearchRecordType)
Tests if the given syllabus search record type is supported.
|
boolean |
supportsVisibleFederation()
Tests if any lesson federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supproted,
false
otherwisemandatory
- This method must be implemented. boolean supportsPlanLookup()
true
if plan lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanQuery()
true
if plan query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanSearch()
true
if plan search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanAdmin()
true
if plan search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanNotification()
true
if plan notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPlanCourseCatalog()
true
if plan course catalog lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanCourseCatalogAssignment()
true
if plan course catalog assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPlanSmartCourseCatalog()
true
if plan smart course catalog is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsLessonLookup()
true
if lesson lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsLessonQuery()
true
if lesson query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsLessonSearch()
true
if lesson search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsLessonAdmin()
true
if lesson administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsLessonNotification()
true
if lesson notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsLessonCourseCatalog()
true
if lesson course catalog lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsLessonCourseCatalogAssignment()
true
if lesson course catalog assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsLessonSmartCourseCatalog()
true
if lesson smart course catalog is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsLessonConflict()
true
if lesson conflict is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsLessonAnchoring()
true
if lesson anchoring is available,
false
otherwisemandatory
- This method must be implemented. TypeList getSyllabusRecordTypes()
Syllabus
record types.mandatory
- This method must be implemented. boolean supportsSyllabusRecordType(Type syllabusRecordType)
Syllabus
record type is supported.syllabusRecordType
- a Type
indicating a
Syllabus
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- syllabusRecordType
is null
mandatory
- This method must be implemented. TypeList getSyllabusSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsSyllabusSearchRecordType(Type syllabusSearchRecordType)
syllabusSearchRecordType
- a Type
indicating a
syllabus record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- syllabusSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getPlanRecordTypes()
Plan
record types.mandatory
- This method must be implemented. boolean supportsPlanRecordType(Type planRecordType)
Plan
record type is supported.planRecordType
- a Type
indicating a Plan
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- planRecordType
is null
mandatory
- This method must be implemented. TypeList getPlanSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsPlanSearchRecordType(Type planSearchRecordType)
planSearchRecordType
- a Type
indicating a plan
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- planSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getLessonRecordTypes()
Lesson
record types.mandatory
- This method must be implemented. boolean supportsLessonRecordType(Type lessonRecordType)
Lesson
record type is supported.lessonRecordType
- a Type
indicating a
Lesson
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- lessonRecordType
is null
mandatory
- This method must be implemented. TypeList getLessonSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsLessonSearchRecordType(Type lessonSearchRecordType)
lessonSearchRecordType
- a Type
indicating a
lesson record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- lessonSearchRecordType
is null
mandatory
- This method must be implemented.