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

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

Method Details

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.