Interface ActivityBatchForm

All Superinterfaces:

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

public interface ActivityBatchForm
extends ActivityForm

This is the form for creating and updating activities in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityBatchAdminSession . 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
Id	getActivityId()	Gets the Id of the activity to be updated if this is an update transaction.
Id	getActivityUnitId()	Gets the ActivityUnit Id of the activity if this is a create transaction.
Id	getCourseOfferingId()	Gets the CourseOffering Id of the activity if this is a create transaction.
Id	getTermId()	Gets the term Id of the activity if this is a create transaction.

Methods inherited from interface ActivityForm

clearContact, clearInstructors, clearMaximumSeats, clearMinimumSeats, clearRecurringWeekly, clearTotalTargetContactTime, clearTotalTargetEffort, clearTotalTargetIndividualEffort, clearWeeklyContactTime, clearWeeklyEffort, clearWeeklyIndividualEffort, getActivityFormRecord, getContactMetadata, getInstructorsMetadata, getMaximumSeatsMetadata, getMinimumSeatsMetadata, getRecurringWeeklyMetadata, getTotalEffortMatadata, getTotalTargetContactTimeMetadata, getTotalTargetIndividualEffortMetadata, getWeeklyContactTimeMetadata, getWeeklyEffortMetadata, getWeeklyIndividualEffortMetadata, setContact, setInstructors, setMaximumSeats, setMinimumSeats, setRecurringWeekly, setTotalTargetContactTime, setTotalTargetEffort, setTotalTargetIndividualEffort, setWeeklyContactTime, setWeeklyEffort, setWeeklyIndividualEffort

Modifier and Type	Method	Description
void	clearContact()	Removes the contact flag.
void	clearInstructors()	Removes the instructors.
void	clearMaximumSeats()	Removes the maximum seats.
void	clearMinimumSeats()	Removes the minimum seats.
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.
ActivityFormRecord	getActivityFormRecord(Type activityRecordType)	Gets the ActivityFormRecord corresponding to the given activity record Type .
Metadata	getContactMetadata()	Gets the metadata for the contact flag.
Metadata	getInstructorsMetadata()	Gets the metadata for the instructors.
Metadata	getMaximumSeatsMetadata()	Gets the metadata for the maximum seats.
Metadata	getMinimumSeatsMetadata()	Gets the metadata for the minimum seats.
Metadata	getRecurringWeeklyMetadata()	Gets the metadata for the recurring weekly flag.
Metadata	getTotalEffortMatadata()	Gets the metadata for the total effort.
Metadata	getTotalTargetContactTimeMetadata()	Gets the metadata for the total contact time.
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	setInstructors(Id[] resourceIds)	Sets the instructors.
void	setMaximumSeats(long seats)	Sets the maximum seating count.
void	setMinimumSeats(long seats)	Sets the minimum seating count.
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 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

getActivityUnitId

Id getActivityUnitId()

Gets the ActivityUnit Id of the activity if this is a create transaction.

Returns:

the activity unit Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getCourseOfferingId

Id getCourseOfferingId()

Gets the CourseOffering Id of the activity if this is a create transaction.

Returns:

the course offering Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

Gets the term Id of the activity if this is a create transaction.

Returns:

the term Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getActivityId

Id getActivityId()

Gets the Id of the activity to be updated if this is an update transaction.

Returns:

the activity Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.