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

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.

MethodgetPriorityMetadata
Description

Gets the metadata for a priority type.

Returnosid.Metadatametadata for the priority
CompliancemandatoryThis method must be implemented.
MethodsetPriority
Description

Sets the priority.

Parametersosid.type.Typeprioritythe new priority
ErrorsINVALID_ARGUMENT priority is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT priority is null
CompliancemandatoryThis method must be implemented.
MethodclearPriority
Description

Removes the priority.

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

Gets the metadata for a timestamp.

Returnosid.Metadatametadata for the timestamp
CompliancemandatoryThis method must be implemented.
MethodsetTimestamp
Description

Sets the timestamp.

Parametersosid.calendaring.DateTimetimestampthe new timestamp
ErrorsINVALID_ARGUMENT timestamp is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT timestamp is null
CompliancemandatoryThis method must be implemented.
MethodgetAgentMetadata
Description

Gets the metadata for the agent.

Returnosid.Metadatametadata for the agent
CompliancemandatoryThis method must be implemented.
MethodsetAgent
Description

Sets the agent.

Parametersosid.id.IdagentIdthe new agent
ErrorsINVALID_ARGUMENT agentId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryFormRecord
Description

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

Parametersosid.type.TypelogEntryRecordTypethe log entry record type
Returnosid.logging.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.