Interface Branch

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject
public interface Branch extends OsidObject, Operable

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

  • Method Details

    • getOriginJournalEntryId

      Id getOriginJournalEntryId()
      Gets the journal entry Id from which this branch was started.
      Returns:
      the journal entry Id
      Compliance:
      mandatory - This method must be implemented.

    • getOriginJournalEntry

      JournalEntry getOriginJournalEntry() throws OperationFailedException
      Gets the journal entry from which this branch was started.
      Returns:
      the journal entry
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLatestJournalEntryId

      Id getLatestJournalEntryId()
      Gets the latest journal entry Id in this branch.
      Returns:
      the journal entry Id
      Compliance:
      mandatory - This method must be implemented.

    • getLatestJournalEntry

      JournalEntry getLatestJournalEntry() throws OperationFailedException
      Gets the latest journal entry in this branch.
      Returns:
      the journal entry
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getBranchRecord

      BranchRecord getBranchRecord(Type branchRecordType) throws OperationFailedException
      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 .
      Parameters:
      branchRecordType - the branch record type
      Returns:
      the branch record
      Throws:
      NullArgumentException - branchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(branchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.