Interface ActivityUnitForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ActivityUnitBatchForm

public interface ActivityUnitForm
extends OsidObjectForm, OsidOperableForm, OsidSubjugateableForm

This is the form for creating and updating ActivityUnits. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ActivityUnitAdminSession. 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	clearContact()	Removes the contact flag.
void	clearLearningObjectives()	Removes the learning objectives.
void	clearRecurringWeekly()	Removes the recurring weekly flag.
void	clearTotalTargetContactTime()	Removes the total contact time.
void	clearTotalTargetEffort()	Removes the total effort.
void	clearTotalTargetIndividualEffort()	Removes the total individual effort.
void	clearWeeklyContactTime()	Removes the weekly contact time.
void	clearWeeklyEffort()	Removes the weekly effort.
void	clearWeeklyIndividualEffort()	Removes the weekly individual effort.
ActivityUnitFormRecord	getActivityUnitFormRecord(Type activityUnitRecordType)	Gets the ActivityUnitFormRecord corresponding to the given activity unit record Type.
Metadata	getContactMetadata()	Gets the metadata for the contact flag.
Metadata	getLearningObjectivesMetadata()	Gets the metadata for a set of learning objectives.
Metadata	getRecurringWeeklyMetadata()	Gets the metadata for the recurring weekly flag.
Metadata	getTotalTargetContactTimeMetadata()	Gets the metadata for the total contact time.
Metadata	getTotalTargetEffortMetadata()	Gets the metadata for the total effort.
Metadata	getTotalTargetIndividualEffortMetadata()	Gets the metadata for the total individual effort.
Metadata	getWeeklyContactTimeMetadata()	Gets the metadata for the weekly contact time.
Metadata	getWeeklyEffortMetadata()	Gets the metadata for the weekly effort.
Metadata	getWeeklyIndividualEffortMetadata()	Gets the metadata for the weekly individual effort.
void	setContact(boolean contact)	Sets the contact flag.
void	setLearningObjectives(Id[] objectiveIds)	Sets the learning objectives.
void	setRecurringWeekly(boolean recurring)	Sets the recurring weekly flag.
void	setTotalTargetContactTime(Duration time)	Sets the total contact time.
void	setTotalTargetEffort(Duration time)	Sets the total effort.
void	setTotalTargetIndividualEffort(Duration time)	Sets the total individual effort.
void	setWeeklyContactTime(Duration time)	Sets the weekly contact time.
void	setWeeklyEffort(Duration time)	Sets the weekly effort.
void	setWeeklyIndividualEffort(Duration time)	Sets the weekly individual effort.

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 OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Method Details

getTotalTargetEffortMetadata

Metadata getTotalTargetEffortMetadata()

Gets the metadata for the total effort. The amount may be calculated from the other data.

Returns:

metadata for the total effort

Compliance:

mandatory - This method must be implemented.

setTotalTargetEffort

void setTotalTargetEffort(Duration time)

Sets the total effort.

Parameters:

time - the new total effort

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearTotalTargetEffort

void clearTotalTargetEffort()

Removes the total effort.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getContactMetadata

Metadata getContactMetadata()

Gets the metadata for the contact flag.

Returns:

metadata for the contact

Compliance:

mandatory - This method must be implemented.

setContact

void setContact(boolean contact)

Sets the contact flag.

Parameters:

contact - the new contact flag

Throws:

InvalidArgumentException - contact is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearContact

void clearContact()

Removes the contact flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTotalTargetContactTimeMetadata

Metadata getTotalTargetContactTimeMetadata()

Gets the metadata for the total contact time.

Returns:

metadata for the total contact time

Compliance:

mandatory - This method must be implemented.

setTotalTargetContactTime

void setTotalTargetContactTime(Duration time)

Sets the total contact time.

Parameters:

time - the new total contact time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearTotalTargetContactTime

void clearTotalTargetContactTime()

Removes the total contact time.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTotalTargetIndividualEffortMetadata

Metadata getTotalTargetIndividualEffortMetadata()

Gets the metadata for the total individual effort. The amount may be calculated from the other data.

Returns:

metadata for the total individual effort

Compliance:

mandatory - This method must be implemented.

setTotalTargetIndividualEffort

void setTotalTargetIndividualEffort(Duration time)

Sets the total individual effort.

Parameters:

time - the new total individual effort

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearTotalTargetIndividualEffort

void clearTotalTargetIndividualEffort()

Removes the total individual effort.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRecurringWeeklyMetadata

Metadata getRecurringWeeklyMetadata()

Gets the metadata for the recurring weekly flag.

Returns:

metadata for the contact

Compliance:

mandatory - This method must be implemented.

setRecurringWeekly

void setRecurringWeekly(boolean recurring)

Sets the recurring weekly flag.

Parameters:

recurring - the new recurring weekly flag

Throws:

InvalidArgumentException - recurring is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRecurringWeekly

void clearRecurringWeekly()

Removes the recurring weekly flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWeeklyEffortMetadata

Metadata getWeeklyEffortMetadata()

Gets the metadata for the weekly effort. The amount may be calculated from the other data.

Returns:

metadata for the weekly effort

Compliance:

mandatory - This method must be implemented.

setWeeklyEffort

void setWeeklyEffort(Duration time)

Sets the weekly effort.

Parameters:

time - the new weekly effort

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearWeeklyEffort

void clearWeeklyEffort()

Removes the weekly effort.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWeeklyContactTimeMetadata

Metadata getWeeklyContactTimeMetadata()

Gets the metadata for the weekly contact time.

Returns:

metadata for the weekly contact time

Compliance:

mandatory - This method must be implemented.

setWeeklyContactTime

void setWeeklyContactTime(Duration time)

Sets the weekly contact time.

Parameters:

time - the new weekly contact time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearWeeklyContactTime

void clearWeeklyContactTime()

Removes the weekly contact time.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWeeklyIndividualEffortMetadata

Metadata getWeeklyIndividualEffortMetadata()

Gets the metadata for the weekly individual effort. The amount may be calculated from the other data.

Returns:

metadata for the weekly individual effort

Compliance:

mandatory - This method must be implemented.

setWeeklyIndividualEffort

void setWeeklyIndividualEffort(Duration time)

Sets the weekly individual effort.

Parameters:

time - the new weekly individual effort

Throws:

InvalidArgumentException - time is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearWeeklyIndividualEffort

void clearWeeklyIndividualEffort()

Removes the weekly individual effort.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLearningObjectivesMetadata

Metadata getLearningObjectivesMetadata()

Gets the metadata for a set of learning objectives.

Returns:

metadata for the obecjtives

Compliance:

mandatory - This method must be implemented.

setLearningObjectives

void setLearningObjectives(Id[] objectiveIds)

Sets the learning objectives.

Parameters:

objectiveIds - the new obejctives

Throws:

InvalidArgumentException - objectiveIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - objectiveIds is null

Compliance:

mandatory - This method must be implemented.

clearLearningObjectives

void clearLearningObjectives()

Removes the learning objectives.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getActivityUnitFormRecord

ActivityUnitFormRecord getActivityUnitFormRecord(Type activityUnitRecordType)
                                          throws OperationFailedException

Gets the ActivityUnitFormRecord corresponding to the given activity unit record Type.

Parameters:

activityUnitRecordType - an activity unit record type

Returns:

the activity unit form record

Throws:

NullArgumentException - activityUnitRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.