org.osid.logging

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

Method Summary

Methods

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

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.