OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.BranchQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
Description

This is the query for searching branches Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchOriginJournalEntryId
Description

Sets the origin journal entry Id for this query.

Parametersosid.id.IdjournalEntryIda journal entry Id Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT journalEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearOriginJournalEntryIdTerms
Description

Clears the origin journal entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOriginJournalEntryQuery
Description

Tests if a JournalEntryQuery is available.

Returnboolean true if a journal entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOriginJournalEntryQuery
Description

Gets the query for an origin journal entry. Multiple retrievals produce a nested OR term.

Returnosid.journaling.JournalEntryQuerythe origin journal entry query
ErrorsUNIMPLEMENTED supportsOriginJournalEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsOriginJournalEntryQuery() is true.
MethodclearOriginJournalEntryTerms
Description

Clears the origin journal entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLatestJournalEntryId
Description

Sets the latest journal entry Id for this query.

Parametersosid.id.IdjournalEntryIda journal entry Id Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT journalEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearLatestJournalEntryIdTerms
Description

Clears the latest journal entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLatestJournalEntryQuery
Description

Tests if a JournalEntryQuery is available.

Returnboolean true if a journal entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLatestJournalEntryQuery
Description

Gets the query for a latest journal entry. Multiple retrievals produce a nested OR term.

Returnosid.journaling.JournalEntryQuerythe latest journal entry query
ErrorsUNIMPLEMENTED supportsOriginJournalEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsOriginJournalEntryQuery() is true.
MethodclearLatestJournalEntryTerms
Description

Clears the latest journal entry terms.

CompliancemandatoryThis method must be implemented.
MethodgetBranchQueryRecord
Description

Gets the branch query record corresponding to the given Branch record Type. Multiple retrievals produce a nested OR term.

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