OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalEntry
Implementsosid.OsidObject
osid.Subjugateable
Used Byosid.OsidManager
osid.OsidProxyManager
osid.journaling.Branch
osid.journaling.BranchAdminSession
osid.journaling.JournalEntryAdminSession
osid.journaling.JournalEntryList
osid.journaling.JournalEntryLookupSession
Description

A JournalEntry represents an entry in a journal.

MethodgetBranchId
Description

Gets the branch Id for this entry.

Returnosid.id.Id the branch Id
Compliancemandatory This method must be implemented.
MethodgetBranch
Description

Gets the branch for this entry.

Returnosid.journaling.Branch the branch
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetSourceId
Description

Gets the principal Id of the journaled object.

Returnosid.id.Id the source Id
Compliancemandatory This method must be implemented.
MethodgetVersionId
Description

Gets the version Id of the journaled object.

Returnosid.id.Id the version Id
Compliancemandatory This method must be implemented.
MethodgetTimestamp
Description

Gets the timestamp of this journal entry.

Returnosid.calendaring.DateTime the time of this entry
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the Id of the resource who created this entry.

Returnosid.id.Id the Resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the resource who created this entry.

Returnosid.resource.Resource the Resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAgentId
Description

Gets the Id of the agent who created this entry.

Returnosid.id.Id the Agent Id
Compliancemandatory This method must be implemented.
MethodgetAgent
Description

Gets the agent who created this entry.

Returnosid.authentication.Agent the Agent
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypejournalEntryRecordType the type of journal entry record to retrieve
Returnosid.journaling.records.JournalEntryRecord the journal entry record
ErrorsNULL_ARGUMENT journalEntryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(journalEntryRecordType) is false
Compliancemandatory This method must be implemented.