public interface CoursePlanProxyManager extends OsidProxyManager, CoursePlanProfile
The course plan manager provides access to planning sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager accept a Proxy
for passing
information from a server environment. 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(Proxy proxy)
Gets the
OsidSession associated with the lesson
administrative service. |
LessonAdminSession |
getLessonAdminSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson
administration service for the given course catalog. |
LessonConflictSession |
getLessonAnchoringSession(Proxy proxy)
Gets the
OsidSession associated with the lesson
conflict service. |
LessonConflictSession |
getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson
anchoring service for the given course catalog. |
LessonConflictSession |
getLessonConflictSession(Proxy proxy)
Gets the
OsidSession associated with the lesson
conflict service. |
LessonConflictSession |
getLessonConflictSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson
conflict service for the given course catalog. |
LessonCourseCatalogAssignmentSession |
getLessonCourseCatalogAssignmentSession(Proxy proxy)
Gets the session for assigning lesson to course catalog mappings.
|
LessonCourseCatalogSession |
getLessonCourseCatalogSession(Proxy proxy)
Gets the session for retrieving lesson to course catalog mappings.
|
LessonLookupSession |
getLessonLookupSession(Proxy proxy)
Gets the
OsidSession associated with the lesson lookup
service. |
LessonLookupSession |
getLessonLookupSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson lookup
service for the given course catalog. |
LessonNotificationSession |
getLessonNotificationSession(LessonReceiver lessonReceiver,
Proxy proxy)
Gets the
OsidSession associated with the lesson
notification service. |
LessonNotificationSession |
getLessonNotificationSessionForCourseCatalog(LessonReceiver lessonReceiver,
Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson
notification service for the given course catalog. |
LessonQuerySession |
getLessonQuerySession(Proxy proxy)
Gets the
OsidSession associated with the lesson query
service. |
LessonQuerySession |
getLessonQuerySessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson query
service for the given course catalog. |
LessonSearchSession |
getLessonSearchSession(Proxy proxy)
Gets the
OsidSession associated with the lesson search
service. |
LessonSearchSession |
getLessonSearchSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the lesson search
service for the given course catalog. |
LessonSmartCourseCatalogSession |
getLessonSmartCourseCatalogSession(Id courseCatalogId,
Proxy proxy)
Gets the session for managing dynamic lesson course catalogs for the
given course catalog.
|
PlanAdminSession |
getPlanAdminSession(Proxy proxy)
Gets the
OsidSession associated with the plan
administration service. |
PlanAdminSession |
getPlanAdminSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the plan
administration service for the given course catalog. |
PlanCourseCatalogAssignmentSession |
getPlanCourseCatalogAssignmentSession(Proxy proxy)
Gets the session for assigning plan to course catalog mappings.
|
PlanCourseCatalogSession |
getPlanCourseCatalogSession(Proxy proxy)
Gets the session for retrieving plan to course catalog mappings.
|
PlanLookupSession |
getPlanLookupSession(Proxy proxy)
Gets the
OsidSession associated with the plan lookup
service. |
PlanLookupSession |
getPlanLookupSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the plan lookup
service for the given course catalog. |
PlanNotificationSession |
getPlanNotificationSession(PlanReceiver planReceiver,
Proxy proxy)
Gets the
OsidSession associated with the plan
notification service. |
PlanNotificationSession |
getPlanNotificationSessionForCourseCatalog(PlanReceiver planReceiver,
Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the plan
notification service for the given course catalog. |
PlanQuerySession |
getPlanQuerySession(Proxy proxy)
Gets the
OsidSession associated with the plan query
service. |
PlanQuerySession |
getPlanQuerySessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the plan query
service for the given course catalog. |
PlanSearchSession |
getPlanSearchSession(Proxy proxy)
Gets the
OsidSession associated with the plan search
service. |
PlanSearchSession |
getPlanSearchSessionForCourseCatalog(Id courseCatalogId,
Proxy proxy)
Gets the
OsidSession associated with the plan search
service for the given course catalog. |
PlanSmartCourseCatalogSession |
getPlanSmartCourseCatalogSession(Id courseCatalogId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the plan lookup
service.proxy
- a proxy PlanLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanLookup()
is false
optional
- This method must be implemented if
supportsPlanLookup()
is true.
PlanLookupSession getPlanLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan lookup
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy PlanLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the plan query
service.proxy
- a proxy PlanQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanQuery()
is false
optional
- This method must be implemented if
supportsPlanQuery()
is true.
PlanQuerySession getPlanQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan query
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy PlanQuerySession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the plan search
service.proxy
- a proxy PlanSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanSearch()
is false
optional
- This method must be implemented if
supportsPlanSearch()
is true.
PlanSearchSession getPlanSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan search
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy PlanSearchSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the plan
administration service.proxy
- a proxy PlanAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPlanAdmin()
is false
optional
- This method must be implemented if
supportsPlanAdmin()
is true.
PlanAdminSession getPlanAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy PlanAdminSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the plan
notification service.planReceiver
- the receiverproxy
- a proxy PlanNotificationSession
NullArgumentException
- planReceiver
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the plan
notification service for the given course catalog.planReceiver
- the receivercourseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy PlanNotificationSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- planReceiver,
courseCatalogId,
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy PlanCourseCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanCourseCatalog()
is false
optional
- This method must be implemented if
supportsPlanCourseCatalog()
is true.
PlanCourseCatalogAssignmentSession getPlanCourseCatalogAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy PlanCourseCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanCourseCatalogAssignment()
is false
optional
- This method must be implemented if
supportsPlanCourseCatalogAssignment()
is
true.
PlanSmartCourseCatalogSession getPlanSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
courseCatalogId
- the Id
of the course catalogproxy
- a proxy PlanSmartCourseCatalogSession
NotFoundException
- courseCatalogId
not
foundNullArgumentException
- courseCatalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPlanSmartCourseCatalog()
is false
optional
- This method must be implemented if
supportsPlanSmartCourseCatalog()
is true.
LessonLookupSession getLessonLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson lookup
service.proxy
- a proxy LessonLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonLookup()
is false
optional
- This method must be implemented if
supportsLessonLookup()
is true.
LessonLookupSession getLessonLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson lookup
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy LessonLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson query
service.proxy
- a proxy LessonQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonQuery()
is false
optional
- This method must be implemented if
supportsLessonQuery()
is true.
LessonQuerySession getLessonQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson query
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy LessonQuerySession
NotFoundException
- no Lesson
found by
the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson search
service.proxy
- a proxy LessonSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonSearch()
is false
optional
- This method must be implemented if
supportsLessonSearch()
is true.
LessonSearchSession getLessonSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson search
service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy LessonSearchSession
NotFoundException
- no Lesson
found by
the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson
administrative service.proxy
- a proxy LessonAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLessonAdmin()
is false
optional
- This method must be implemented if
supportsLessonAdmin()
is true.
LessonAdminSession getLessonAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy LessonAdminSession
NotFoundException
- no Lesson
found by
the given Id
NullArgumentException
- courseCatalogId
or proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson
notification service.lessonReceiver
- the receiverproxy
- a proxy LessonNotificationSession
NullArgumentException
- lessonReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
notification service for the given course catalog.lessonReceiver
- the receivercourseCatalogId
- the Id
of the
CourseCatalog
proxy
- a proxy LessonNotificationSession
NotFoundException
- no Lesson
found by
the given Id
NullArgumentException
- lessonReceiver,
courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy LessonCourseCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonCourseCatalog()
is false
optional
- This method must be implemented if
supportsLessonCourseCatalog()
is true.
LessonCourseCatalogAssignmentSession getLessonCourseCatalogAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy LessonCourseCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonCourseCatalogAssignment()
is
false
optional
- This method must be implemented if
supportsLessonCourseCatalogAssignment()
is
true.
LessonSmartCourseCatalogSession getLessonSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
courseCatalogId
- the Id
of a course catalogproxy
- a proxy LessonSmartCourseCatalogSession
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonSmartCourseCatalog()
is false
optional
- This method must be implemented if
supportsLessonSmartCourseCatalog()
is true.
LessonConflictSession getLessonConflictSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson
conflict service.proxy
- a proxy LessonConflictSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonConflict()
is false
optional
- This method must be implemented if
supportsLessonConflict()
is true.
LessonConflictSession getLessonConflictSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
conflict service for the given course catalog.courseCatalogId
- the Id
of the course catalogproxy
- a proxy LessonConflictSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the lesson
conflict service.proxy
- a proxy LessonConflictSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonConflict()
is false
optional
- This method must be implemented if
supportsLessonConflict()
is true.
LessonConflictSession getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the lesson
anchoring service for the given course catalog.courseCatalogId
- the Id
of the course catalogproxy
- a proxy LessonAnchoringSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLessonAnchoring()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLessonAnchoring()
and
supportsVisibleFederation()
are true