org.osid.tracking

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

Methods

Modifier and Type	Method and 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(java.lang.String message) Sets the message.
void	setSummary(java.lang.String summary) Sets the summary.

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

getSummaryMetadata

Metadata getSummaryMetadata()

Gets the metadata for the summary.

Returns:

metadata for the summary

Compliance:

mandatory - This method must be implemented.

setSummary

void setSummary(java.lang.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(java.lang.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.