Interface EntryForm

All Superinterfaces:

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

All Known Subinterfaces:

EntryBatchForm

public interface EntryForm
extends OsidObjectForm, OsidSourceableForm

This is the form for creating and updating Entries . Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EntryAdminSession . 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
void	clearCopyright()	Clears the copyright.
void	clearPoster()	Clears the poster.
void	clearSubjectLine()	Clears the subject line.
void	clearSummary()	Clears the summary.
void	clearText()	Clears the text.
void	clearTimestamp()	Clears the poster.
Metadata	getCopyrightMetadata()	Gets the metadata for the copyright.
EntryFormRecord	getEntryFormRecord(Type entryRecordType)	Gets the EntryFormRecord corresponding to the given Entry record Type .
Metadata	getPosterMetadata()	Gets the metadata for the poster.
Metadata	getSubjectLineMetadata()	Gets the metadata for the subject line.
Metadata	getSummaryMetadata()	Gets the metadata for the summary.
Metadata	getTextMetadata()	Gets the metadata for the text.
Metadata	getTimestampMetadata()	Gets the metadata for the timestamp.
void	setCopyright(String copyright)	Sets the copyright.
void	setPoster(Id resourceId)	Sets the poster.
void	setSubjectLine(String subjectLine)	Sets the subject line.
void	setSummary(String summary)	Sets the summary.
void	setText(String text)	Sets the text.
void	setTimestamp(DateTime timestamp)	Sets the timestamp.

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 OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Modifier and Type	Method	Description
void	clearBranding()	Removes the branding.
void	clearLicense()	Removes the license.
void	clearProvider()	Removes the provider.
Metadata	getBrandingMetadata()	Gets the metadata for the asset branding.
Metadata	getLicenseMetadata()	Gets the metadata for the license.
Metadata	getProviderMetadata()	Gets the metadata for a provider.
void	setBranding(Id[] assetIds)	Sets the branding.
void	setLicense(String license)	Sets the license.
void	setProvider(Id providerId)	Sets a provider.

Method Details

getTimestampMetadata

Metadata getTimestampMetadata()

Gets the metadata for the timestamp.

Returns:

metadata for the timestamp

Compliance:

mandatory - This method must be implemented.

setTimestamp

void setTimestamp(DateTime timestamp)

Sets the timestamp.

Parameters:

timestamp - the new timestamp

Throws:

InvalidArgumentException - timestamp is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - timestamp is null

Compliance:

mandatory - This method must be implemented.

clearTimestamp

void clearTimestamp()

Clears the poster.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPosterMetadata

Metadata getPosterMetadata()

Gets the metadata for the poster.

Returns:

metadata for the poster

Compliance:

mandatory - This method must be implemented.

setPoster

void setPoster(Id resourceId)

Sets the poster.

Parameters:

resourceId - the new poster

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearPoster

void clearPoster()

Clears the poster.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSubjectLineMetadata

Metadata getSubjectLineMetadata()

Gets the metadata for the subject line.

Returns:

metadata for the subject line

Compliance:

mandatory - This method must be implemented.

setSubjectLine

void setSubjectLine(String subjectLine)

Sets the subject line.

Parameters:

subjectLine - the new subject line

Throws:

InvalidArgumentException - subjectLine is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - subjectLine is null

Compliance:

mandatory - This method must be implemented.

clearSubjectLine

void clearSubjectLine()

Clears the subject line.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSummaryMetadata

Metadata getSummaryMetadata()

Gets the metadata for the summary.

Returns:

metadata for the summary

Compliance:

mandatory - This method must be implemented.

setSummary

void setSummary(String summary)

Sets the summary.

Parameters:

summary - the new summary

Throws:

InvalidArgumentException - summary is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - summary is null

Compliance:

mandatory - This method must be implemented.

clearSummary

void clearSummary()

Clears the summary.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTextMetadata

Metadata getTextMetadata()

Gets the metadata for the text.

Returns:

metadata for the text

Compliance:

mandatory - This method must be implemented.

setText

void setText(String text)

Sets the text.

Parameters:

text - the new text

Throws:

InvalidArgumentException - text is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - text is null

Compliance:

mandatory - This method must be implemented.

clearText

void clearText()

Clears the text.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCopyrightMetadata

Metadata getCopyrightMetadata()

Gets the metadata for the copyright.

Returns:

metadata for the copyright

Compliance:

mandatory - This method must be implemented.

setCopyright

void setCopyright(String copyright)

Sets the copyright.

Parameters:

copyright - the new copyright

Throws:

InvalidArgumentException - copyright is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - copyright is null

Compliance:

mandatory - This method must be implemented.

clearCopyright

void clearCopyright()

Clears the copyright.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEntryFormRecord

EntryFormRecord getEntryFormRecord(Type entryRecordType)
                            throws OperationFailedException

Gets the EntryFormRecord corresponding to the given Entry record Type .

Parameters:

entryRecordType - the entry record type

Returns:

the entry form record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.