public interface JournalEntry extends OsidObject, Subjugateable
A JournalEntry
represents an entry in a journal.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getBranchId()
Id
for this entry. Id
mandatory
- This method must be implemented. Branch getBranch() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getSourceId()
Id
of the journaled object. Id
mandatory
- This method must be implemented. Id getVersionId()
Id
of the journaled object. Id
mandatory
- This method must be implemented. DateTime getTimestamp()
timestamp
of this journal entry.mandatory
- This method must be implemented. Id getResourceId()
Resource
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getAgentId()
Agent
Id
mandatory
- This method must be implemented. Agent getAgent() throws OperationFailedException
Agent
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. JournalEntryRecord getJournalEntryRecord(Type journalEntryRecordType) throws OperationFailedException
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
.journalEntryRecordType
- the type of journal entry record to
retrieveNullArgumentException
- journalEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(journalEntryRecordType)
is false
mandatory
- This method must be implemented.