public interface CoursePlanManager extends OsidManager, CoursePlanProfile
The course plan manager provides access to course planning sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
PlanLookupSession:
a session to lookup plans PlanQuerySession:
a session to query plans PlanSearchSession:
a session to search plans PlanAdminSession:
a session to manage plans PlanNotificationSession:
a session to subscribe to
notifications of plan changes PlanCourseCatalogSession:
a session to lookup plan
course catalog mappings PlanCourseCatalogAssignmentSession:
a session to
manage plan course catalog mappings PlanSmartCourseCatalogSession:
a session to manage
smart course catalogs of plans LessonLookupSession:
a session to retrieve lessons
LessonQuerySession:
a session to query lessons
LessonSearchSession:
a session to search for
lessons LessonAdminSession:
a session to create, update
and delete lessons LessonNotificationSession:
a session to receive
notifications for changes in lessons LessonCourseCatalogSession:
a session to lookup
lesson course catalog mappings LessonCourseCatalogAssignmentSession:
a session to
manage lesson course catalog mappings LessonSmartCourseCatalogSession:
a session to
manage smart course catalogs of lessons LessonConflictSession:
a session to examine gaps
and overlapps in lessons LessonAnchoringSession:
a session to anchor
lessons to specific activities and times The course plan manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
LessonAdminSession |
getLessonAdminSession()
Gets the
OsidSession associated with the lesson
administrative service. |
LessonAdminSession |
getLessonAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson
administrative service for the given course catalog. |
LessonConflictSession |
getLessonAnchoringSession()
Gets the
OsidSession associated with the lesson
conflict service. |
LessonConflictSession |
getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson
anchoring service for the given course catalog. |
LessonConflictSession |
getLessonConflictSession()
Gets the
OsidSession associated with the lesson
conflict service. |
LessonConflictSession |
getLessonConflictSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson
conflict service for the given course catalog. |
LessonCourseCatalogAssignmentSession |
getLessonCourseCatalogAssignmentSession()
Gets the session for assigning lesson to course catalog mappings.
|
LessonCourseCatalogSession |
getLessonCourseCatalogSession()
Gets the session for retrieving lesson to course catalog mappings.
|
LessonLookupSession |
getLessonLookupSession()
Gets the
OsidSession associated with the lesson lookup
service. |
LessonLookupSession |
getLessonLookupSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson lookup
service for the given course catalog. |
LessonNotificationSession |
getLessonNotificationSession(LessonReceiver lessonReceiver)
Gets the
OsidSession associated with the lesson
notification service. |
LessonNotificationSession |
getLessonNotificationSessionForCourseCatalog(LessonReceiver lessonReceiver,
Id courseCatalogId)
Gets the
OsidSession associated with the lesson
notification service for the given course catalog. |
LessonQuerySession |
getLessonQuerySession()
Gets the
OsidSession associated with the lesson query
service. |
LessonQuerySession |
getLessonQuerySessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson query
service for the given course catalog. |
LessonSearchSession |
getLessonSearchSession()
Gets the
OsidSession associated with the lesson search
service. |
LessonSearchSession |
getLessonSearchSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the lesson search
service for the given course catalog. |
LessonSmartCourseCatalogSession |
getLessonSmartCourseCatalogSession(Id courseCatalogId)
Gets the session associated with the lesson smart course catalog for
the given course catalog.
|
PlanAdminSession |
getPlanAdminSession()
Gets the
OsidSession associated with the plan
administration service. |
PlanAdminSession |
getPlanAdminSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the plan
administration service for the given course catalog. |
PlanCourseCatalogAssignmentSession |
getPlanCourseCatalogAssignmentSession()
Gets the session for assigning plan to course catalog mappings.
|
PlanCourseCatalogSession |
getPlanCourseCatalogSession()
Gets the session for retrieving plan to course catalog mappings.
|
PlanLookupSession |
getPlanLookupSession()
Gets the
OsidSession associated with the plan lookup
service. |
PlanLookupSession |
getPlanLookupSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the plan lookup
service for the given course catalog. |
PlanNotificationSession |
getPlanNotificationSession(PlanReceiver planReceiver)
Gets the
OsidSession associated with the plan
notification service. |
PlanNotificationSession |
getPlanNotificationSessionForCourseCatalog(PlanReceiver planReceiver,
Id courseCatalogId)
Gets the
OsidSession associated with the plan
notification service for the given course catalog. |
PlanQuerySession |
getPlanQuerySession()
Gets the
OsidSession associated with the plan query
service. |
PlanQuerySession |
getPlanQuerySessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the plan query
service for the given course catalog. |
PlanSearchSession |
getPlanSearchSession()
Gets the
OsidSession associated with the plan search
service. |
PlanSearchSession |
getPlanSearchSessionForCourseCatalog(Id courseCatalogId)
Gets the
OsidSession associated with the plan search
service for the given course catalog. |
PlanSmartCourseCatalogSession |
getPlanSmartCourseCatalogSession(Id courseCatalogId)
Gets the session associated with the plan smart course catalog for the
given course catalog.
|
changeBranch, initialize, rollbackService
close
getLessonRecordTypes, getLessonSearchRecordTypes, getPlanRecordTypes, getPlanSearchRecordTypes, getSyllabusRecordTypes, getSyllabusSearchRecordTypes, supportsLessonAdmin, supportsLessonAnchoring, supportsLessonConflict, supportsLessonCourseCatalog, supportsLessonCourseCatalogAssignment, supportsLessonLookup, supportsLessonNotification, supportsLessonQuery, supportsLessonRecordType, supportsLessonSearch, supportsLessonSearchRecordType, supportsLessonSmartCourseCatalog, supportsPlanAdmin, supportsPlanCourseCatalog, supportsPlanCourseCatalogAssignment, supportsPlanLookup, supportsPlanNotification, supportsPlanQuery, supportsPlanRecordType, supportsPlanSearch, supportsPlanSearchRecordType, supportsPlanSmartCourseCatalog, supportsSyllabusRecordType, supportsSyllabusSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PlanLookupSession getPlanLookupSession() throws OperationFailedException
OsidSession
associated with the plan lookup
service. PlanLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanLookup()
is false
optional
- This method must be implemented if
supportsPlanLookup()
is true.
PlanLookupSession getPlanLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan lookup
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
PlanLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPlanLookup()
and
supportsVisibleFederation()
are true
PlanQuerySession getPlanQuerySession() throws OperationFailedException
OsidSession
associated with the plan query
service. PlanQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanQuery()
is false
optional
- This method must be implemented if
supportsPlanQuery()
is true.
PlanQuerySession getPlanQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan query
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
PlanQuerySession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPlanQuery()
and
supportsVisibleFederation()
are true
PlanSearchSession getPlanSearchSession() throws OperationFailedException
OsidSession
associated with the plan search
service. PlanSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanSearch()
is false
optional
- This method must be implemented if
supportsPlanSearch()
is true.
PlanSearchSession getPlanSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan search
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
PlanSearchSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPlanSearch()
and
supportsVisibleFederation()
are true
PlanAdminSession getPlanAdminSession() throws OperationFailedException
OsidSession
associated with the plan
administration service. PlanAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanAdmin()
is false
optional
- This method must be implemented if
supportsPlanAdmin()
is true.
PlanAdminSession getPlanAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
PlanAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPlanAdmin()
and
supportsVisibleFederation()
are true
PlanNotificationSession getPlanNotificationSession(PlanReceiver planReceiver) throws OperationFailedException
OsidSession
associated with the plan
notification service.planReceiver
- the receiver PlanNotificationSession
NullArgumentException
- planReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanNotification()
is false
optional
- This method must be implemented if
supportsPlanNotification()
is true.
PlanNotificationSession getPlanNotificationSessionForCourseCatalog(PlanReceiver planReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan
notification service for the given course catalog.planReceiver
- the receivercourseCatalogId
- the Id
of the
CourseCatalog
PlanNotificationSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- planReceiver
or
courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPlanNotification()
and
supportsVisibleFederation()
are true
PlanCourseCatalogSession getPlanCourseCatalogSession() throws OperationFailedException
PlanCourseCatalogSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanCourseCatalog()
is false
optional
- This method must be implemented if
supportsPlanCourseCatalog()
is true.
PlanCourseCatalogAssignmentSession getPlanCourseCatalogAssignmentSession() throws OperationFailedException
PlanCourseCatalogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanCourseCatalogAssignment()
is false
optional
- This method must be implemented if
supportsPlanCourseCatalogAssignment()
is
true.
PlanSmartCourseCatalogSession getPlanSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
courseCatalogId
- the Id
of the course catalog PlanSmartCourseCatalogSession
NotFoundException
- courseCatalogId
not
foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanSmartCourseCatalog()
is false
optional
- This method must be implemented if
supportsPlanSmartCourseCatalog()
is true.
LessonLookupSession getLessonLookupSession() throws OperationFailedException
OsidSession
associated with the lesson lookup
service. LessonLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonLookup()
is false
optional
- This method must be implemented if
supportsLessonLookup()
is true.
LessonLookupSession getLessonLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson lookup
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
LessonLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLessonLookup()
and
supportsVisibleFederation()
are true
LessonQuerySession getLessonQuerySession() throws OperationFailedException
OsidSession
associated with the lesson query
service. LessonQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonQuery()
is false
optional
- This method must be implemented if
supportsLessonQuery()
is true.
LessonQuerySession getLessonQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson query
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
LessonQuerySession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLessonQuery()
and
supportsVisibleFederation()
are true
LessonSearchSession getLessonSearchSession() throws OperationFailedException
OsidSession
associated with the lesson search
service. LessonSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonSearch()
is false
optional
- This method must be implemented if
supportsLessonSearch()
is true.
LessonSearchSession getLessonSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson search
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
LessonSearchSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLessonSearch()
and
supportsVisibleFederation()
are true
LessonAdminSession getLessonAdminSession() throws OperationFailedException
OsidSession
associated with the lesson
administrative service. LessonAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonAdmin()
is false
optional
- This method must be implemented if
supportsLessonAdmin()
is true.
LessonAdminSession getLessonAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
administrative service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
LessonAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLessonAdmin()
and
supportsVisibleFederation()
are true
LessonNotificationSession getLessonNotificationSession(LessonReceiver lessonReceiver) throws OperationFailedException
OsidSession
associated with the lesson
notification service.lessonReceiver
- the receiver LessonNotificationSession
NullArgumentException
- lessonReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonNotification()
is false
optional
- This method must be implemented if
supportsLessonNotification()
is true.
LessonNotificationSession getLessonNotificationSessionForCourseCatalog(LessonReceiver lessonReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
notification service for the given course catalog.lessonReceiver
- the receivercourseCatalogId
- the Id
of the
CourseCatalog
LessonNotificationSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- lessonReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLessonNotification()
and
supportsVisibleFederation()
are true
LessonCourseCatalogSession getLessonCourseCatalogSession() throws OperationFailedException
LessonCourseCatalogSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonCourseCatalog()
is false
optional
- This method must be implemented if
supportsLessonCourseCatalog()
is true.
LessonCourseCatalogAssignmentSession getLessonCourseCatalogAssignmentSession() throws OperationFailedException
LessonCourseCatalogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonCourseCatalogAssignment()
is
false
optional
- This method must be implemented if
supportsLessonCourseCatalogAssignment()
is
true.
LessonSmartCourseCatalogSession getLessonSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
courseCatalogId
- the Id
of the course catalog LessonSmartCourseCatalogSession
NotFoundException
- courseCatalogId
not
foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonSmartCourseCatalog()
is false
optional
- This method must be implemented if
supportsLessonSmartCourseCatalog()
is true.
LessonConflictSession getLessonConflictSession() throws OperationFailedException
OsidSession
associated with the lesson
conflict service. LessonConflictSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonConflict()
is false
optional
- This method must be implemented if
supportsLessonConflict()
is true.
LessonConflictSession getLessonConflictSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
conflict service for the given course catalog.courseCatalogId
- the Id
of the Lesson
LessonConflictSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonConflict()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLessonConflict()
and
supportsVisibleFederation()
are true
LessonConflictSession getLessonAnchoringSession() throws OperationFailedException
OsidSession
associated with the lesson
conflict service. LessonConflictSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonConflict()
is false
optional
- This method must be implemented if
supportsLessonConflict()
is true.
LessonConflictSession getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
anchoring service for the given course catalog.courseCatalogId
- the Id
of the Lesson
LessonAnchoringSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonAnchoring()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLessonAnchoring()
and
supportsVisibleFederation()
are true