Interface OsidContainableForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

All Known Subinterfaces:

AssessmentPartForm, CompositionBatchForm, CompositionForm, EventBatchForm, EventForm, RecurringEventBatchForm, RecurringEventForm, ReplyBatchForm, ReplyForm, RequisiteForm, ScheduleSlotBatchForm, ScheduleSlotForm, TodoBatchForm, TodoForm

public interface OsidContainableForm
extends OsidForm

This form is used to create and update containers.

Method Summary

Modifier and Type	Method	Description
void	clearSequestered()	Clears the sequestered flag.
Metadata	getSequesteredMetadata()	Gets the metadata for the sequestered flag.
void	setSequestered(boolean sequestered)	Sets the sequestered flag.

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 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.

Method Details

getSequesteredMetadata

Metadata getSequesteredMetadata()

Gets the metadata for the sequestered flag.

Returns:

metadata for the sequestered flag

Compliance:

mandatory - This method must be implemented.

setSequestered

void setSequestered(boolean sequestered)

Sets the sequestered flag.

Parameters:

sequestered - the new sequestered flag

Throws:

InvalidArgumentException - sequestered is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearSequestered

void clearSequestered()

Clears the sequestered flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.