org.osid

Interface OsidCompendiumForm

All Superinterfaces:

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

public interface OsidCompendiumForm
extends OsidObjectForm, OsidSubjugateableForm

This form is used to create and update governators.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearEndDate() Clears the end date.
void	clearExtrapolated() Clears the extrapolated flag.
void	clearInterpolated() Clears the interpolated flag.
void	clearStartDate() Clears the start date.
Metadata	getEndDateMetadata() Gets the metadata for an end date.
Metadata	getExtrapolatedMetadata() Gets the metadata for the extrapolated flag.
Metadata	getInterpolatedMetadata() Gets the metadata for the interpolated flag.
Metadata	getStartDateMetadata() Gets the metadata for a start date.
void	setEndDate(DateTime date) Sets the end date.
void	setExtrapolated(boolean extrapolated) Sets the extrapolated flag.
void	setInterpolated(boolean interpolated) Sets the interpolated flag.
void	setStartDate(DateTime date) Sets the start date.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

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

getStartDateMetadata

Metadata getStartDateMetadata()

Gets the metadata for a start date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setStartDate

void setStartDate(DateTime date)

Sets the start date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearStartDate

void clearStartDate()

Clears the start date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEndDateMetadata

Metadata getEndDateMetadata()

Gets the metadata for an end date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setEndDate

void setEndDate(DateTime date)

Sets the end date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearEndDate

void clearEndDate()

Clears the end date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInterpolatedMetadata

Metadata getInterpolatedMetadata()

Gets the metadata for the interpolated flag.

Returns:

metadata for the interpolated flag

Compliance:

mandatory - This method must be implemented.

setInterpolated

void setInterpolated(boolean interpolated)

Sets the interpolated flag.

Parameters:

interpolated - the new interpolated flag

Throws:

InvalidArgumentException - interpolated is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearInterpolated

void clearInterpolated()

Clears the interpolated flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getExtrapolatedMetadata

Metadata getExtrapolatedMetadata()

Gets the metadata for the extrapolated flag.

Returns:

metadata for the extrapolated flag

Compliance:

mandatory - This method must be implemented.

setExtrapolated

void setExtrapolated(boolean extrapolated)

Sets the extrapolated flag.

Parameters:

extrapolated - the new extrapolated flag

Throws:

InvalidArgumentException - extrapolated is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearExtrapolated

void clearExtrapolated()

Clears the extrapolated flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.