Interface LogEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

LogEntryBatchForm

public interface LogEntryForm
extends OsidObjectForm

This is the form for creating and updating log entries. Like all OsidForms, 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.

Method Summary

Modifier and Type	Method	Description
void	clearPriority()	Removes the priority.
Metadata	getAgentMetadata()	Gets the metadata for the agent.
LogEntryFormRecord	getLogEntryFormRecord(Type logEntryRecordType)	Gets the LogEntryFormRecord corresponding to the given log entry record Type.
Metadata	getPriorityMetadata()	Gets the metadata for a priority type.
Metadata	getTimestampMetadata()	Gets the metadata for a timestamp.
void	setAgent(Id agentId)	Sets the agent.
void	setPriority(Type priority)	Sets the priority.
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.

Method Details

getPriorityMetadata

Metadata getPriorityMetadata()

Gets the metadata for a priority type.

Returns:

metadata for the priority

Compliance:

mandatory - This method must be implemented.

setPriority

void setPriority(Type priority)

Sets the priority.

Parameters:

priority - the new priority

Throws:

InvalidArgumentException - priority is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - priority is null

Compliance:

mandatory - This method must be implemented.

clearPriority

void clearPriority()

Removes the priority.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTimestampMetadata

Metadata getTimestampMetadata()

Gets the metadata for a 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.

getAgentMetadata

Metadata getAgentMetadata()

Gets the metadata for the agent.

Returns:

metadata for the agent

Compliance:

mandatory - This method must be implemented.

setAgent

void setAgent(Id agentId)

Sets the agent.

Parameters:

agentId - the new agent

Throws:

InvalidArgumentException - agentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - agentId is null

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 - the 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.