Interface CoursePlanProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CoursePlanProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface CoursePlanProfile

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

Modifier and Type	Method	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.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getPlanLookupSession

PlanLookupSession getPlanLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the plan lookup service.

Parameters:

proxy - a proxy

Returns:

a PlanLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanLookup()} is {@code true} .

getPlanLookupSessionForCourseCatalog

PlanLookupSession getPlanLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the plan lookup service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a PlanLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanLookup()} and {@code supportsVisibleFederation()} are {@code true}

getPlanQuerySession

PlanQuerySession getPlanQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the plan query service.

Parameters:

proxy - a proxy

Returns:

a PlanQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanQuery()} is {@code true} .

getPlanQuerySessionForCourseCatalog

PlanQuerySession getPlanQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the plan query service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a PlanQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanQuery()} and {@code supportsVisibleFederation()} are {@code true}

getPlanSearchSession

PlanSearchSession getPlanSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the plan search service.

Parameters:

proxy - a proxy

Returns:

a PlanSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanSearch()} is {@code true} .

getPlanSearchSessionForCourseCatalog

PlanSearchSession getPlanSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the plan search service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a PlanSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanSearch()} and {@code supportsVisibleFederation()} are {@code true}

getPlanAdminSession

PlanAdminSession getPlanAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the plan administration service.

Parameters:

proxy - a proxy

Returns:

a PlanAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanAdmin()} is {@code true} .

getPlanAdminSessionForCourseCatalog

PlanAdminSession getPlanAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the plan administration service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a PlanAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPlanNotificationSession

PlanNotificationSession getPlanNotificationSession(PlanReceiver planReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the plan notification service.

Parameters:

planReceiver - the receiver

proxy - a proxy

Returns:

a PlanNotificationSession

Throws:

NullArgumentException - planReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanNotification()} is {@code true} .

getPlanNotificationSessionForCourseCatalog

PlanNotificationSession getPlanNotificationSessionForCourseCatalog(PlanReceiver planReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the plan notification service for the given course catalog.

Parameters:

planReceiver - the receiver

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a PlanNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - planReceiver, courseCatalogId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanNotification()} and {@code supportsVisibleFederation()} are {@code true}

getPlanCourseCatalogSession

PlanCourseCatalogSession getPlanCourseCatalogSession(Proxy proxy)
                                              throws OperationFailedException

Gets the session for retrieving plan to course catalog mappings.

Parameters:

proxy - a proxy

Returns:

a PlanCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanCourseCatalog()} is {@code true} .

getPlanCourseCatalogAssignmentSession

PlanCourseCatalogAssignmentSession getPlanCourseCatalogAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the session for assigning plan to course catalog mappings.

Parameters:

proxy - a proxy

Returns:

a PlanCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanCourseCatalogAssignment()} is {@code true} .

getPlanSmartCourseCatalogSession

PlanSmartCourseCatalogSession getPlanSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the session associated with the plan smart course catalog for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - a proxy

Returns:

a PlanSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsPlanSmartCourseCatalog()} is {@code true} .

getLessonLookupSession

LessonLookupSession getLessonLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the lesson lookup service.

Parameters:

proxy - a proxy

Returns:

a LessonLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonLookup()} is {@code true} .

getLessonLookupSessionForCourseCatalog

LessonLookupSession getLessonLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson lookup service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a LessonLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonLookup()} and {@code supportsVisibleFederation()} are {@code true}

getLessonQuerySession

LessonQuerySession getLessonQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the lesson query service.

Parameters:

proxy - a proxy

Returns:

a LessonQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonQuery()} is {@code true} .

getLessonQuerySessionForCourseCatalog

LessonQuerySession getLessonQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson query service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a LessonQuerySession

Throws:

NotFoundException - no Lesson found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonQuery()} and {@code supportsVisibleFederation()} are {@code true}

getLessonSearchSession

LessonSearchSession getLessonSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the lesson search service.

Parameters:

proxy - a proxy

Returns:

a LessonSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonSearch()} is {@code true} .

getLessonSearchSessionForCourseCatalog

LessonSearchSession getLessonSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson search service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a LessonSearchSession

Throws:

NotFoundException - no Lesson found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonSearch()} and {@code supportsVisibleFederation()} are {@code true}

getLessonAdminSession

LessonAdminSession getLessonAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the lesson administrative service.

Parameters:

proxy - a proxy

Returns:

a LessonAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonAdmin()} is {@code true} .

getLessonAdminSessionForCourseCatalog

LessonAdminSession getLessonAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson administration service for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a LessonAdminSession

Throws:

NotFoundException - no Lesson found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getLessonNotificationSession

LessonNotificationSession getLessonNotificationSession(LessonReceiver lessonReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the lesson notification service.

Parameters:

lessonReceiver - the receiver

proxy - a proxy

Returns:

a LessonNotificationSession

Throws:

NullArgumentException - lessonReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonNotification()} is {@code true} .

getLessonNotificationSessionForCourseCatalog

LessonNotificationSession getLessonNotificationSessionForCourseCatalog(LessonReceiver lessonReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson notification service for the given course catalog.

Parameters:

lessonReceiver - the receiver

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a LessonNotificationSession

Throws:

NotFoundException - no Lesson found by the given Id

NullArgumentException - lessonReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonNotification()} and {@code supportsVisibleFederation()} are {@code true}

getLessonCourseCatalogSession

LessonCourseCatalogSession getLessonCourseCatalogSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the session for retrieving lesson to course catalog mappings.

Parameters:

proxy - a proxy

Returns:

a LessonCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonCourseCatalog()} is {@code true} .

getLessonCourseCatalogAssignmentSession

LessonCourseCatalogAssignmentSession getLessonCourseCatalogAssignmentSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the session for assigning lesson to course catalog mappings.

Parameters:

proxy - a proxy

Returns:

a LessonCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonCourseCatalogAssignment()} is {@code true} .

getLessonSmartCourseCatalogSession

LessonSmartCourseCatalogSession getLessonSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic lesson course catalogs for the given course catalog.

Parameters:

courseCatalogId - the Id of a course catalog

proxy - a proxy

Returns:

a LessonSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonSmartCourseCatalog()} is {@code true} .

getLessonConflictSession

LessonConflictSession getLessonConflictSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the lesson conflict service.

Parameters:

proxy - a proxy

Returns:

a LessonConflictSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonConflict()} is {@code true} .

getLessonConflictSessionForCourseCatalog

LessonConflictSession getLessonConflictSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson conflict service for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - a proxy

Returns:

a LessonConflictSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonConflict()} and {@code supportsVisibleFederation()} are {@code true}

getLessonAnchoringSession

LessonConflictSession getLessonAnchoringSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the lesson conflict service.

Parameters:

proxy - a proxy

Returns:

a LessonConflictSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonConflict()} is {@code true} .

getLessonAnchoringSessionForCourseCatalog

LessonConflictSession getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the lesson anchoring service for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - a proxy

Returns:

a LessonAnchoringSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAnchoring() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLessonAnchoring()} and {@code supportsVisibleFederation()} are {@code true}