Interface LessonForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

public interface LessonForm
extends OsidRelationshipForm

This is the form for creating and updating Lessons. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the LessonAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
void	clearActivities()	Clears the activities.
void	clearActualEndingActivity()	Clears the actual ending activity.
void	clearActualEndTme()	Clears the actual end time.
void	clearActualStartingActivity()	Clears the actual starting activity.
void	clearActualStartTime()	Clears the actual start time.
void	clearActualTimeSpent()	Clears the actual time spent.
void	clearBegun()	Clears the begun flag.
void	clearComplete()	Clears the complete flag.
void	clearPlannedStartTime()	Clears the planned start time.
void	clearSkipped()	Clears the skipped flag.
Metadata	getActivitiesMetadata()	Gets the metadata for the activities.
Metadata	getActualEndingActivityMetadata()	Gets the metadata for the actual ending activity.
Metadata	getActualEndTimeMetadata()	Gets the metadata for the actual end time.
Metadata	getActualStartingActivityMetadata()	Gets the metadata for the actual starting activity.
Metadata	getActualStartTimeMetadata()	Gets the metadata for the actual start time.
Metadata	getActualTimeSpentMetadata()	Gets the metadata for the actual time spent.
Metadata	getBegunMetadata()	Gets the metadata for the begun flag.
Metadata	getCompleteMetadata()	Gets the metadata for the complete flag.
LessonFormRecord	getLessonFormRecord(Type lessonRecordType)	Gets the LessonFormRecord corresponding to the given lesson record Type.
Metadata	getPlannedStartTimeMetadata()	Gets the metadata for the planned start time.
Metadata	getSkippedMetadata()	Gets the metadata for the skipped flag.
void	setActivities(IdList activityIds)	Sets the activities.
void	setActualEndingActivity(Id activityId)	Sets the actual ending activity.
void	setActualEndTime(Duration time)	Sets the actual end time.
void	setActualStartingActivity(Id activityId)	Sets the actual starting activity.
void	setActualStartTime(Duration time)	Sets the actual start time.
void	setActualTimeSpent(Duration duration)	Sets the actual time spent.
void	setBegun(boolean begun)	Sets the begun flag.
void	setComplete(boolean complete)	Sets the complete flag.
void	setPlannedStartTime(Duration time)	Sets the planned start time.
void	setSkipped(boolean skipped)	Sets the skipped flag.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getActivitiesMetadata

Metadata getActivitiesMetadata()

Gets the metadata for the activities.

Returns:

metadata for the activities

Compliance:

mandatory - This method must be implemented.

setActivities

void setActivities(IdList activityIds)

Sets the activities.

Parameters:

activityIds - the new activities

Throws:

InvalidArgumentException - activityIds is invalid

NoAccessException - activityIds cannot be modified

NullArgumentException - activityIds is null

Compliance:

mandatory - This method must be implemented.

clearActivities

void clearActivities()

Clears the activities.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPlannedStartTimeMetadata

Metadata getPlannedStartTimeMetadata()

Gets the metadata for the planned start time.

Returns:

metadata for the planned start time

Compliance:

mandatory - This method must be implemented.

setPlannedStartTime

void setPlannedStartTime(Duration time)

Sets the planned start time. The time is expressed as a time relative to the starting time of the first activity.

Parameters:

time - the new planned start time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - time cannot be modified

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearPlannedStartTime

void clearPlannedStartTime()

Clears the planned start time.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBegunMetadata

Metadata getBegunMetadata()

Gets the metadata for the begun flag.

Returns:

metadata for the begun flag

Compliance:

mandatory - This method must be implemented.

setBegun

void setBegun(boolean begun)

Sets the begun flag.

Parameters:

begun - the new begun flag

Throws:

InvalidArgumentException - begun is invalid

NoAccessException - begun cannot be modified

Compliance:

mandatory - This method must be implemented.

clearBegun

void clearBegun()

Clears the begun flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActualStartTimeMetadata

Metadata getActualStartTimeMetadata()

Gets the metadata for the actual start time. The time is expressed as a time relative to the starting time of the actual starting activity.

Returns:

metadata for the actual start time

Compliance:

mandatory - This method must be implemented.

setActualStartTime

void setActualStartTime(Duration time)

Sets the actual start time.

Parameters:

time - the new actual start time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - time cannot be modified

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearActualStartTime

void clearActualStartTime()

Clears the actual start time.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActualStartingActivityMetadata

Metadata getActualStartingActivityMetadata()

Gets the metadata for the actual starting activity.

Returns:

metadata for the actual starting activity

Compliance:

mandatory - This method must be implemented.

setActualStartingActivity

void setActualStartingActivity(Id activityId)

Sets the actual starting activity.

Parameters:

activityId - the new actual starting activity

Throws:

InvalidArgumentException - activityId is invalid

NoAccessException - activityId cannot be modified

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActualStartingActivity

void clearActualStartingActivity()

Clears the actual starting activity.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCompleteMetadata

Metadata getCompleteMetadata()

Gets the metadata for the complete flag.

Returns:

metadata for the complete flag

Compliance:

mandatory - This method must be implemented.

setComplete

void setComplete(boolean complete)

Sets the complete flag.

Parameters:

complete - the new complete flag

Throws:

InvalidArgumentException - complete is invalid

NoAccessException - complete cannot be modified

Compliance:

mandatory - This method must be implemented.

clearComplete

void clearComplete()

Clears the complete flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSkippedMetadata

Metadata getSkippedMetadata()

Gets the metadata for the skipped flag.

Returns:

metadata for the skipped flag

Compliance:

mandatory - This method must be implemented.

setSkipped

void setSkipped(boolean skipped)

Sets the skipped flag.

Parameters:

skipped - the new skipped flag

Throws:

InvalidArgumentException - skipped is invalid

NoAccessException - skipped cannot be modified

Compliance:

mandatory - This method must be implemented.

clearSkipped

void clearSkipped()

Clears the skipped flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActualEndTimeMetadata

Metadata getActualEndTimeMetadata()

Gets the metadata for the actual end time.

Returns:

metadata for the actual end time

Compliance:

mandatory - This method must be implemented.

setActualEndTime

void setActualEndTime(Duration time)

Sets the actual end time. The time is expressed as a time relative to the starting time of the ending activity.

Parameters:

time - the new actual end time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - time cannot be modified

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearActualEndTme

void clearActualEndTme()

Clears the actual end time.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActualEndingActivityMetadata

Metadata getActualEndingActivityMetadata()

Gets the metadata for the actual ending activity.

Returns:

metadata for the actual ending activity

Compliance:

mandatory - This method must be implemented.

setActualEndingActivity

void setActualEndingActivity(Id activityId)

Sets the actual ending activity.

Parameters:

activityId - the new actual ending activity

Throws:

InvalidArgumentException - activityId is invalid

NoAccessException - activityId cannot be modified

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActualEndingActivity

void clearActualEndingActivity()

Clears the actual ending activity.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getActualTimeSpentMetadata

Metadata getActualTimeSpentMetadata()

Gets the metadata for the actual time spent.

Returns:

metadata for the actual time spent

Compliance:

mandatory - This method must be implemented.

setActualTimeSpent

void setActualTimeSpent(Duration duration)

Sets the actual time spent.

Parameters:

duration - the new duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - duration cannot be modified

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearActualTimeSpent

void clearActualTimeSpent()

Clears the actual time spent.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLessonFormRecord

LessonFormRecord getLessonFormRecord(Type lessonRecordType)
                              throws OperationFailedException

Gets the LessonFormRecord corresponding to the given lesson record Type.

Parameters:

lessonRecordType - the lesson record type

Returns:

the lesson form record

Throws:

NullArgumentException - lessonRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonRecordType) is false

Compliance:

mandatory - This method must be implemented.