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

A Branch is a new version chain from an existing version chain.

MethodgetOriginJournalEntryId
Description

Gets the journal entry Id from which this branch was started.

Returnosid.id.Idthe journal entry Id
CompliancemandatoryThis method must be implemented.
MethodgetOriginJournalEntry
Description

Gets the journal entry from which this branch was started.

Returnosid.journaling.JournalEntrythe journal entry
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetLatestJournalEntryId
Description

Gets the latest journal entry Id in this branch.

Returnosid.id.Idthe journal entry Id
CompliancemandatoryThis method must be implemented.
MethodgetLatestJournalEntry
Description

Gets the latest journal entry in this branch.

Returnosid.journaling.JournalEntrythe journal entry
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetBranchRecord
Description

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

Parametersosid.type.TypebranchRecordTypethe branch record type
Returnosid.journaling.records.BranchRecordthe branch record
ErrorsNULL_ARGUMENT branchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(branchRecordType) is false
CompliancemandatoryThis method must be implemented.