org.osid.course.plan

Interface CoursePlanManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CoursePlanProfile, OsidManager, OsidProfile, Sourceable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.course.plan.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPlanLookupSession

PlanLookupSession getPlanLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the plan lookup service.

Returns:

a PlanLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanLookup() is false

Compliance:

optional - This method must be implemented if supportsPlanLookup() is true.

getPlanLookupSessionForCourseCatalog

PlanLookupSession getPlanLookupSessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a PlanLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPlanLookup() and supportsVisibleFederation() are true

getPlanQuerySession

PlanQuerySession getPlanQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the plan query service.

Returns:

a PlanQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanQuery() is false

Compliance:

optional - This method must be implemented if supportsPlanQuery() is true.

getPlanQuerySessionForCourseCatalog

PlanQuerySession getPlanQuerySessionForCourseCatalog(Id courseCatalogId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a PlanQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPlanQuery() and supportsVisibleFederation() are true

getPlanSearchSession

PlanSearchSession getPlanSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the plan search service.

Returns:

a PlanSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSearch() is false

Compliance:

optional - This method must be implemented if supportsPlanSearch() is true.

getPlanSearchSessionForCourseCatalog

PlanSearchSession getPlanSearchSessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a PlanSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPlanSearch() and supportsVisibleFederation() are true

getPlanAdminSession

PlanAdminSession getPlanAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the plan administration service.

Returns:

a PlanAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanAdmin() is false

Compliance:

optional - This method must be implemented if supportsPlanAdmin() is true.

getPlanAdminSessionForCourseCatalog

PlanAdminSession getPlanAdminSessionForCourseCatalog(Id courseCatalogId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a PlanAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPlanAdmin() and supportsVisibleFederation() are true

getPlanNotificationSession

PlanNotificationSession getPlanNotificationSession(PlanReceiver planReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the plan notification service.

Parameters:

planReceiver - the receiver

Returns:

a PlanNotificationSession

Throws:

NullArgumentException - planReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanNotification() is false

Compliance:

optional - This method must be implemented if supportsPlanNotification() is true.

getPlanNotificationSessionForCourseCatalog

PlanNotificationSession getPlanNotificationSessionForCourseCatalog(PlanReceiver planReceiver,
                                                                 Id courseCatalogId)
                                                                   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

Returns:

a PlanNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - planReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPlanNotification() and supportsVisibleFederation() are true

getPlanCourseCatalogSession

PlanCourseCatalogSession getPlanCourseCatalogSession()
                                                     throws OperationFailedException

Gets the session for retrieving plan to course catalog mappings.

Returns:

a PlanCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsPlanCourseCatalog() is true.

getPlanCourseCatalogAssignmentSession

PlanCourseCatalogAssignmentSession getPlanCourseCatalogAssignmentSession()
                                                                         throws OperationFailedException

Gets the session for assigning plan to course catalog mappings.

Returns:

a PlanCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsPlanCourseCatalogAssignment() is true.

getPlanSmartCourseCatalogSession

PlanSmartCourseCatalogSession getPlanSmartCourseCatalogSession(Id courseCatalogId)
                                                               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

Returns:

a PlanSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPlanSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsPlanSmartCourseCatalog() is true.

getLessonLookupSession

LessonLookupSession getLessonLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the lesson lookup service.

Returns:

a LessonLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonLookup() is false

Compliance:

optional - This method must be implemented if supportsLessonLookup() is true.

getLessonLookupSessionForCourseCatalog

LessonLookupSession getLessonLookupSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a LessonLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonLookup() and supportsVisibleFederation() are true

getLessonQuerySession

LessonQuerySession getLessonQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the lesson query service.

Returns:

a LessonQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonQuery() is false

Compliance:

optional - This method must be implemented if supportsLessonQuery() is true.

getLessonQuerySessionForCourseCatalog

LessonQuerySession getLessonQuerySessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a LessonQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonQuery() and supportsVisibleFederation() are true

getLessonSearchSession

LessonSearchSession getLessonSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the lesson search service.

Returns:

a LessonSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSearch() is false

Compliance:

optional - This method must be implemented if supportsLessonSearch() is true.

getLessonSearchSessionForCourseCatalog

LessonSearchSession getLessonSearchSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a LessonSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonSearch() and supportsVisibleFederation() are true

getLessonAdminSession

LessonAdminSession getLessonAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the lesson administrative service.

Returns:

a LessonAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAdmin() is false

Compliance:

optional - This method must be implemented if supportsLessonAdmin() is true.

getLessonAdminSessionForCourseCatalog

LessonAdminSession getLessonAdminSessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a LessonAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonAdmin() and supportsVisibleFederation() are true

getLessonNotificationSession

LessonNotificationSession getLessonNotificationSession(LessonReceiver lessonReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the lesson notification service.

Parameters:

lessonReceiver - the receiver

Returns:

a LessonNotificationSession

Throws:

NullArgumentException - lessonReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonNotification() is false

Compliance:

optional - This method must be implemented if supportsLessonNotification() is true.

getLessonNotificationSessionForCourseCatalog

LessonNotificationSession getLessonNotificationSessionForCourseCatalog(LessonReceiver lessonReceiver,
                                                                     Id courseCatalogId)
                                                                       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

Returns:

a LessonNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - lessonReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonNotification() and supportsVisibleFederation() are true

getLessonCourseCatalogSession

LessonCourseCatalogSession getLessonCourseCatalogSession()
                                                         throws OperationFailedException

Gets the session for retrieving lesson to course catalog mappings.

Returns:

a LessonCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsLessonCourseCatalog() is true.

getLessonCourseCatalogAssignmentSession

LessonCourseCatalogAssignmentSession getLessonCourseCatalogAssignmentSession()
                                                                             throws OperationFailedException

Gets the session for assigning lesson to course catalog mappings.

Returns:

a LessonCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsLessonCourseCatalogAssignment() is true.

getLessonSmartCourseCatalogSession

LessonSmartCourseCatalogSession getLessonSmartCourseCatalogSession(Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a LessonSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsLessonSmartCourseCatalog() is true.

getLessonConflictSession

LessonConflictSession getLessonConflictSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the lesson conflict service.

Returns:

a LessonConflictSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() is false

Compliance:

optional - This method must be implemented if supportsLessonConflict() is true.

getLessonConflictSessionForCourseCatalog

LessonConflictSession getLessonConflictSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Lesson

Returns:

a LessonConflictSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonConflict() and supportsVisibleFederation() are true

getLessonAnchoringSession

LessonConflictSession getLessonAnchoringSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the lesson conflict service.

Returns:

a LessonConflictSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonConflict() is false

Compliance:

optional - This method must be implemented if supportsLessonConflict() is true.

getLessonAnchoringSessionForCourseCatalog

LessonConflictSession getLessonAnchoringSessionForCourseCatalog(Id courseCatalogId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Lesson

Returns:

a LessonAnchoringSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLessonAnchoring() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLessonAnchoring() and supportsVisibleFederation() are true