org.osid

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

Methods

Modifier and Type	Method and 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 org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

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.