OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.LogEntryForm
Implementsosid.OsidObjectForm
Description

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.

MethodgetSummaryMetadata
Description

Gets the metadata for the summary.

Returnosid.Metadatametadata for the summary
CompliancemandatoryThis method must be implemented.
MethodsetSummary
Description

Sets the summary.

Parametersstringsummarythe new summary
ErrorsINVALID_ARGUMENT summary is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT summary is null
CompliancemandatoryThis method must be implemented.
MethodclearSummary
Description

Removes the summary.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetMessageMetadata
Description

Gets the metadata for the message.

Returnosid.Metadatametadata for the summary
CompliancemandatoryThis method must be implemented.
MethodsetMessage
Description

Sets the message.

Parametersstringmessagethe new message
ErrorsINVALID_ARGUMENT message is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT message is null
CompliancemandatoryThis method must be implemented.
MethodclearMessage
Description

Removes the message.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryFormRecord
Description

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

Parametersosid.type.TypelogEntryRecordTypea log entry record type
Returnosid.tracking.records.LogEntryFormRecordthe log entry form record
ErrorsNULL_ARGUMENT logEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logEntryRecordType) is false
CompliancemandatoryThis method must be implemented.