OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntry
Implementsosid.OsidObject
osid.Subjugateable
Description

A JournalEntry represents an entry in a journal.

MethodgetBranchId
Description

Gets the branch Id for this entry.

Returnosid.id.Idthe branch Id
CompliancemandatoryThis method must be implemented.
MethodgetBranch
Description

Gets the branch for this entry.

Returnosid.journaling.Branchthe branch
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSourceId
Description

Gets the principal Id of the journaled object.

Returnosid.id.Idthe source Id
CompliancemandatoryThis method must be implemented.
MethodgetVersionId
Description

Gets the version Id of the journaled object.

Returnosid.id.Idthe version Id
CompliancemandatoryThis method must be implemented.
MethodgetTimestamp
Description

Gets the timestamp of this journal entry.

Returnosid.calendaring.DateTimethe time of this entry
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the Id of the resource who created this entry.

Returnosid.id.Idthe Resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource who created this entry.

Returnosid.resource.Resourcethe Resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAgentId
Description

Gets the Id of the agent who created this entry.

Returnosid.id.Idthe Agent Id
CompliancemandatoryThis method must be implemented.
MethodgetAgent
Description

Gets the agent who created this entry.

Returnosid.authentication.Agentthe Agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntryRecord
Description

Gets the journal entry record corresponding to the given JournalEntry record Type. This method is used to retrieve an object implementing the requested record. The journalEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(journalEntryRecordType) is true .

Parametersosid.type.TypejournalEntryRecordTypethe type of journal entry record to retrieve
Returnosid.journaling.records.JournalEntryRecordthe journal entry record
ErrorsNULL_ARGUMENT journalEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalEntryRecordType) is false
CompliancemandatoryThis method must be implemented.