org.osid.journaling

Interface JournalEntry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface JournalEntry
extends OsidObject, Subjugateable

A JournalEntry represents an entry in a journal.

Method Summary

Methods

Modifier and Type	Method and Description
Agent	getAgent() Gets the agent who created this entry.
Id	getAgentId() Gets the Id of the agent who created this entry.
Branch	getBranch() Gets the branch for this entry.
Id	getBranchId() Gets the branch Id for this entry.
JournalEntryRecord	getJournalEntryRecord(Type journalEntryRecordType) Gets the journal entry record corresponding to the given JournalEntry record Type.
Resource	getResource() Gets the resource who created this entry.
Id	getResourceId() Gets the Id of the resource who created this entry.
Id	getSourceId() Gets the principal Id of the journaled object.
DateTime	getTimestamp() Gets the timestamp of this journal entry.
Id	getVersionId() Gets the version Id of the journaled object.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getBranchId

Id getBranchId()

Gets the branch Id for this entry.

Returns:

the branch Id

Compliance:

mandatory - This method must be implemented.

getBranch

Branch getBranch()
                 throws OperationFailedException

Gets the branch for this entry.

Returns:

the branch

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getSourceId

Id getSourceId()

Gets the principal Id of the journaled object.

Returns:

the source Id

Compliance:

mandatory - This method must be implemented.

getVersionId

Id getVersionId()

Gets the version Id of the journaled object.

Returns:

the version Id

Compliance:

mandatory - This method must be implemented.

getTimestamp

DateTime getTimestamp()

Gets the timestamp of this journal entry.

Returns:

the time of this entry

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

Gets the Id of the resource who created this entry.

Returns:

the Resource Id

Compliance:

mandatory - This method must be implemented.

getResource

Resource getResource()
                     throws OperationFailedException

Gets the resource who created this entry.

Returns:

the Resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAgentId

Id getAgentId()

Gets the Id of the agent who created this entry.

Returns:

the Agent Id

Compliance:

mandatory - This method must be implemented.

getAgent

Agent getAgent()
               throws OperationFailedException

Gets the agent who created this entry.

Returns:

the Agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getJournalEntryRecord

JournalEntryRecord getJournalEntryRecord(Type journalEntryRecordType)
                                         throws OperationFailedException

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 .

Parameters:

journalEntryRecordType - the type of journal entry record to retrieve

Returns:

the journal entry record

Throws:

NullArgumentException - journalEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.