org.osid.journaling

Interface BranchQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, Suppliable

public interface BranchQuery
extends OsidObjectQuery, OsidOperableQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearLatestJournalEntryIdTerms() Clears the latest journal entry Id terms.
void	clearLatestJournalEntryTerms() Clears the latest journal entry terms.
void	clearOriginJournalEntryIdTerms() Clears the origin journal entry Id terms.
void	clearOriginJournalEntryTerms() Clears the origin journal entry terms.
BranchQueryRecord	getBranchQueryRecord(Type branchRecordType) Gets the branch query record corresponding to the given Branch record Type.
JournalEntryQuery	getLatestJournalEntryQuery() Gets the query for a latest journal entry.
JournalEntryQuery	getOriginJournalEntryQuery() Gets the query for an origin journal entry.
void	matchLatestJournalEntryId(Id journalEntryId, boolean match) Sets the latest journal entry Id for this query.
void	matchOriginJournalEntryId(Id journalEntryId, boolean match) Sets the origin journal entry Id for this query.
boolean	supportsLatestJournalEntryQuery() Tests if a JournalEntryQuery is available.
boolean	supportsOriginJournalEntryQuery() Tests if a JournalEntryQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchOriginJournalEntryId

void matchOriginJournalEntryId(Id journalEntryId,
                             boolean match)

Sets the origin journal entry Id for this query.

Parameters:

journalEntryId - a journal entry Id Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - journalEntryId is null

Compliance:

mandatory - This method must be implemented.

clearOriginJournalEntryIdTerms

void clearOriginJournalEntryIdTerms()

Clears the origin journal entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOriginJournalEntryQuery

boolean supportsOriginJournalEntryQuery()

Tests if a JournalEntryQuery is available.

Returns:

true if a journal entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOriginJournalEntryQuery

JournalEntryQuery getOriginJournalEntryQuery()

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

Returns:

the origin journal entry query

Throws:

UnimplementedException - supportsOriginJournalEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsOriginJournalEntryQuery() is true.

clearOriginJournalEntryTerms

void clearOriginJournalEntryTerms()

Clears the origin journal entry terms.

Compliance:

mandatory - This method must be implemented.

matchLatestJournalEntryId

void matchLatestJournalEntryId(Id journalEntryId,
                             boolean match)

Sets the latest journal entry Id for this query.

Parameters:

journalEntryId - a journal entry Id Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - journalEntryId is null

Compliance:

mandatory - This method must be implemented.

clearLatestJournalEntryIdTerms

void clearLatestJournalEntryIdTerms()

Clears the latest journal entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLatestJournalEntryQuery

boolean supportsLatestJournalEntryQuery()

Tests if a JournalEntryQuery is available.

Returns:

true if a journal entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLatestJournalEntryQuery

JournalEntryQuery getLatestJournalEntryQuery()

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

Returns:

the latest journal entry query

Throws:

UnimplementedException - supportsOriginJournalEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsOriginJournalEntryQuery() is true.

clearLatestJournalEntryTerms

void clearLatestJournalEntryTerms()

Clears the latest journal entry terms.

Compliance:

mandatory - This method must be implemented.

getBranchQueryRecord

BranchQueryRecord getBranchQueryRecord(Type branchRecordType)
                                       throws OperationFailedException

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

Parameters:

branchRecordType - a branch record type

Returns:

the branch query record

Throws:

NullArgumentException - branchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(branchRecordType) is false

Compliance:

mandatory - This method must be implemented.