OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.Branch
Implementsosid.OsidObject
osid.Operable
Used Byosid.OsidProfile
osid.journaling.BranchAdminSession
osid.journaling.BranchList
osid.journaling.BranchLookupSession
osid.journaling.JournalEntry
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.Id the journal entry Id
Compliancemandatory This method must be implemented.
MethodgetOriginJournalEntry
Description

Gets the journal entry from which this branch was started.

Returnosid.journaling.JournalEntry the journal entry
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetLatestJournalEntryId
Description

Gets the latest journal entry Id in this branch.

Returnosid.id.Id the journal entry Id
Compliancemandatory This method must be implemented.
MethodgetLatestJournalEntry
Description

Gets the latest journal entry in this branch.

Returnosid.journaling.JournalEntry the journal entry
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypebranchRecordType the branch record type
Returnosid.journaling.records.BranchRecord the branch record
ErrorsNULL_ARGUMENT branchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(branchRecordType) is false
Compliancemandatory This method must be implemented.