Interface LessonAnchoringSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LessonAnchoringSession
extends OsidSession

This session provides a way of "anchoring" lessons with a plan. Lessons correspond to their corresponding Docents laid out along the related Activities . The LessonAnchor ties a Lesson to a specific Activity or at a specific time offet within the specific Activity .

Automatic generation of Lessons should be constrained around the LessonAnchors .

Method Summary

Modifier and Type	Method	Description
void	addLessonAnchor(Id lessonId, Id activityId, Duration offset)	Adds a lesson anchor.
boolean	canAnchorLessons()	Tests if this user can anchor lessons.
void	clearLessonAnchorsForLesson(Id lessonId)	Clears all lesson anchors in a lesson.
void	clearLessonAnchorsForLessonByOffset(Id lessonId, Duration start, Duration end)	Clears all lesson anchors within the given offset range inclusive.
void	clearLessonAnchorsForPlan(Id planId)	Clears all lesson anchors for an entire plan.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
LessonAnchorList	getLessonAnchorsForLesson(Id lessonId)	Gets all lesson anchors for a lesson.
LessonAnchorList	getLessonAnchorsForPlan(Id planId)	Gets all lesson anchors for a plan.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                        throws OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAnchorLessons

boolean canAnchorLessons()

Tests if this user can anchor lessons. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations.

Returns:

false if plan anchoring methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include plans in course catalogs which are children of this course catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getLessonAnchorsForPlan

LessonAnchorList getLessonAnchorsForPlan(Id planId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all lesson anchors for a plan.

Parameters:

planId - a plan Id

Returns:

a list of lesson anchors

Throws:

NotFoundException - planId is not found

NullArgumentException - planId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLessonAnchorsForLesson

LessonAnchorList getLessonAnchorsForLesson(Id lessonId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all lesson anchors for a lesson.

Parameters:

lessonId - a lesson Id

Returns:

a list of lesson anchors

Throws:

NotFoundException - lessonId is not found

NullArgumentException - lessonId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addLessonAnchor

void addLessonAnchor(Id lessonId,
 Id activityId,
 Duration offset)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a lesson anchor.

Parameters:

lessonId - a lesson Id

activityId - an activity Id

offset - a time offset

Throws:

NotFoundException - lessonId or activityId is not found, or activityId is not related to lessonId

NullArgumentException - lessonId, activityId , or offset is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearLessonAnchorsForPlan

void clearLessonAnchorsForPlan(Id planId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears all lesson anchors for an entire plan.

Parameters:

planId - a plan Id

Throws:

NotFoundException - planId is not found

NullArgumentException - planId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearLessonAnchorsForLesson

void clearLessonAnchorsForLesson(Id lessonId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears all lesson anchors in a lesson.

Parameters:

lessonId - a lesson Id

Throws:

NotFoundException - lessonId is not found

NullArgumentException - lessonId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearLessonAnchorsForLessonByOffset

void clearLessonAnchorsForLessonByOffset(Id lessonId,
 Duration start,
 Duration end)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears all lesson anchors within the given offset range inclusive.

Parameters:

lessonId - a lesson Id

start - a starting time offset

end - an ending time offset

Throws:

InvalidArgumentException - start is greater than end

NotFoundException - lessonId is not found

NullArgumentException - lessonId, start , or end is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.