Interface LessonConflictSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LessonConflictSession
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
boolean	canAnchorLessons()	Tests if this user can anchor lessons.
ActivityList	getActivitiesWithLessonGaps(Id planId)	Gets a list of activities with lesson gaps.
IdList	getActivityIdsWithLessonGaps(Id planId)	Gets a list of activity Ids with lesson gaps or missing lessons.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
IdList	getEndingOffsetLessonIds(Id planId)	Gets a list of lesson Ids that do not end at the end of an activity.
LessonList	getEndingOffsetLessons(Id planId)	Gets a list of lessons that do not end at the end of an activity.
LessonList	getLessonsForPlan(Id planId)	Gets all lessons for a plan.
IdList	getOverlappingLessonIds(Id planId)	Gets a list of overlapping lessons.
LessonList	getOverlappingLessons(Id planId)	Gets a list of overlapping lessons.
IdList	getStartingOffsetLessonIds(Id planId)	Gets a list of lesson Ids that do not begin at the start of an activity.
LessonList	getStartingOffsetLessons(Id planId)	Gets a list of lessons that do not begin at the start of an activity.
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.

getLessonsForPlan

LessonList getLessonsForPlan(Id planId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all lessons for a plan.

Parameters:

planId - a plan Id

Returns:

a list of lessons

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.

getOverlappingLessonIds

IdList getOverlappingLessonIds(Id planId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of overlapping lessons.

Parameters:

planId - a plan Id

Returns:

a list of lesson Ids

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.

getOverlappingLessons

LessonList getOverlappingLessons(Id planId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of overlapping lessons.

Parameters:

planId - a plan Id

Returns:

a list of lessons

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.

getStartingOffsetLessonIds

IdList getStartingOffsetLessonIds(Id planId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of lesson Ids that do not begin at the start of an activity.

Parameters:

planId - a plan Id

Returns:

a list of lesson Ids

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.

getStartingOffsetLessons

LessonList getStartingOffsetLessons(Id planId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of lessons that do not begin at the start of an activity.

Parameters:

planId - a plan Id

Returns:

a list of lessons

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.

getEndingOffsetLessonIds

IdList getEndingOffsetLessonIds(Id planId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of lesson Ids that do not end at the end of an activity.

Parameters:

planId - a plan Id

Returns:

a list of lesson Ids

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.

getEndingOffsetLessons

LessonList getEndingOffsetLessons(Id planId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of lessons that do not end at the end of an activity.

Parameters:

planId - a plan Id

Returns:

a list of lessons

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.

getActivityIdsWithLessonGaps

IdList getActivityIdsWithLessonGaps(Id planId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of activity Ids with lesson gaps or missing lessons.

Parameters:

planId - a plan Id

Returns:

a list of activity Ids

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.

getActivitiesWithLessonGaps

ActivityList getActivitiesWithLessonGaps(Id planId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of activities with lesson gaps.

Parameters:

planId - a plan Id

Returns:

a list of activities

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.