Interface LogEntryForm

All Superinterfaces:

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

public interface LogEntryForm
extends OsidObjectForm

This is the form for creating and updating LogEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the LogEntryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the log entry segments.

Method Summary

Modifier and Type	Method	Description
void	clearMessage()	Removes the message.
void	clearSummary()	Removes the summary.
LogEntryFormRecord	getLogEntryFormRecord(Type logEntryRecordType)	Gets the LogEntryFormRecord corresponding to the given log entry record Type.
Metadata	getMessageMetadata()	Gets the metadata for the message.
Metadata	getSummaryMetadata()	Gets the metadata for the summary.
void	setMessage(String message)	Sets the message.
void	setSummary(String summary)	Sets the summary.

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

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()

Removes the summary.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMessageMetadata

Metadata getMessageMetadata()

Gets the metadata for the message.

Returns:

metadata for the summary

Compliance:

mandatory - This method must be implemented.

setMessage

void setMessage(String message)

Sets the message.

Parameters:

message - the new message

Throws:

InvalidArgumentException - message is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - message is null

Compliance:

mandatory - This method must be implemented.

clearMessage

void clearMessage()

Removes the message.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLogEntryFormRecord

LogEntryFormRecord getLogEntryFormRecord(Type logEntryRecordType)
                                  throws OperationFailedException

Gets the LogEntryFormRecord corresponding to the given log entry record Type.

Parameters:

logEntryRecordType - a log entry record type

Returns:

the log entry form record

Throws:

NullArgumentException - logEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.