org.osid.journaling

Interface JournalQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface JournalQuery
extends OsidCatalogQuery

This is the query for searching for journals. 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	clearAncestorJournalIdTerms() Clears the ancestor journal Id terms.
void	clearAncestorJournalTerms() Clears the ancestor journal terms.
void	clearBranchIdTerms() Clears the branch Id terms.
void	clearBranchTerms() Clears the branch terms.
void	clearDescendantJournalIdTerms() Clears the descendant journal Id terms.
void	clearDescendantJournalTerms() Clears the descendant journal terms.
void	clearJournalEntryIdTerms() Clears the journal entry Id terms.
void	clearJournalEntryTerms() Clears the journal entry terms.
JournalQuery	getAncestorJournalQuery() Gets the query for a journal.
BranchQuery	getBranchQuery() Gets the query for a branch.
JournalQuery	getDescendantJournalQuery() Gets the query for a journal.
JournalEntryQuery	getJournalEntryQuery() Gets the query for a journal.
JournalQueryRecord	getJournalQueryRecord(Type journalRecordType) Gets the journal query record corresponding to the given Journal record Type.
void	matchAncestorJournalId(Id journalId, boolean match) Sets the journal Id for this query to match journals that have the specified journal as an ancestor.
void	matchAnyAncestorJournal(boolean match) Matches journals with any ancestor.
void	matchAnyBranch(boolean match) Matches journals with any branches.
void	matchAnyDescendantJournal(boolean match) Matches journals with any descendant.
void	matchAnyJournalEntry(boolean match) Matches journals with any journal entry.
void	matchBranchId(Id branchId, boolean match) Sets the branch Id for this query to match branches assigned to journals.
void	matchDescendantJournalId(Id journalId, boolean match) Sets the journal Id for this query to match journals that have the specified journal as a descendant.
void	matchJournalEntryId(Id journalEntryId, boolean match) Sets the journal entry Id for this query to match entries assigned to journals.
boolean	supportsAncestorJournalQuery() Tests if a JournalQuery is available.
boolean	supportsBranchQuery() Tests if a branch query is available.
boolean	supportsDescendantJournalQuery() Tests if a JournalQuery is available.
boolean	supportsJournalEntryQuery() Tests if a journal entry query is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, 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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchJournalEntryId

void matchJournalEntryId(Id journalEntryId,
                       boolean match)

Sets the journal entry Id for this query to match entries assigned to journals.

Specified by:

matchJournalEntryId in interface OsidObjectQuery

Parameters:

journalEntryId - a journal entry Id

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

Throws:

NullArgumentException - journalEntryId is null

Compliance:

mandatory - This method must be implemented.

clearJournalEntryIdTerms

void clearJournalEntryIdTerms()

Clears the journal entry Id terms.

Specified by:

clearJournalEntryIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryQuery

boolean supportsJournalEntryQuery()

Tests if a journal entry query is available.

Specified by:

supportsJournalEntryQuery in interface OsidObjectQuery

Returns:

true if a journal entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJournalEntryQuery

JournalEntryQuery getJournalEntryQuery()

Gets the query for a journal.

Specified by:

getJournalEntryQuery in interface OsidObjectQuery

Returns:

the journal entry query

Throws:

UnimplementedException - supportsJournalEntryQuery() is false

Compliance:

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

matchAnyJournalEntry

void matchAnyJournalEntry(boolean match)

Matches journals with any journal entry.

Specified by:

matchAnyJournalEntry in interface OsidObjectQuery

Parameters:

match - true to match journals with any journal entry, false to match journals with no entries

Compliance:

mandatory - This method must be implemented.

clearJournalEntryTerms

void clearJournalEntryTerms()

Clears the journal entry terms.

Specified by:

clearJournalEntryTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchBranchId

void matchBranchId(Id branchId,
                 boolean match)

Sets the branch Id for this query to match branches assigned to journals.

Parameters:

branchId - a branch Id

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

Throws:

NullArgumentException - branchId is null

Compliance:

mandatory - This method must be implemented.

clearBranchIdTerms

void clearBranchIdTerms()

Clears the branch Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBranchQuery

boolean supportsBranchQuery()

Tests if a branch query is available.

Returns:

true if a branch query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBranchQuery

BranchQuery getBranchQuery()

Gets the query for a branch.

Returns:

the branch query

Throws:

UnimplementedException - supportsBranchQuery() is false

Compliance:

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

matchAnyBranch

void matchAnyBranch(boolean match)

Matches journals with any branches.

Parameters:

match - true to match journals with any branch, false to match journals with no branches

Compliance:

mandatory - This method must be implemented.

clearBranchTerms

void clearBranchTerms()

Clears the branch terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorJournalId

void matchAncestorJournalId(Id journalId,
                          boolean match)

Sets the journal Id for this query to match journals that have the specified journal as an ancestor.

Parameters:

journalId - a journal Id

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

Throws:

NullArgumentException - journalId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorJournalIdTerms

void clearAncestorJournalIdTerms()

Clears the ancestor journal Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorJournalQuery

boolean supportsAncestorJournalQuery()

Tests if a JournalQuery is available.

Returns:

true if a journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorJournalQuery

JournalQuery getAncestorJournalQuery()

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

Returns:

the journal query

Throws:

UnimplementedException - supportsAncestorJournalQuery() is false

Compliance:

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

matchAnyAncestorJournal

void matchAnyAncestorJournal(boolean match)

Matches journals with any ancestor.

Parameters:

match - true to match journals with any ancestor, false to match root journals

Compliance:

mandatory - This method must be implemented.

clearAncestorJournalTerms

void clearAncestorJournalTerms()

Clears the ancestor journal terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantJournalId

void matchDescendantJournalId(Id journalId,
                            boolean match)

Sets the journal Id for this query to match journals that have the specified journal as a descendant.

Parameters:

journalId - a journal Id

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

Throws:

NullArgumentException - journalId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantJournalIdTerms

void clearDescendantJournalIdTerms()

Clears the descendant journal Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantJournalQuery

boolean supportsDescendantJournalQuery()

Tests if a JournalQuery is available.

Returns:

true if a journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantJournalQuery

JournalQuery getDescendantJournalQuery()

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

Returns:

the journal query

Throws:

UnimplementedException - supportsDescendantJournalQuery() is false

Compliance:

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

matchAnyDescendantJournal

void matchAnyDescendantJournal(boolean match)

Matches journals with any descendant.

Parameters:

match - true to match journals with any descendant, false to match leaf journals

Compliance:

mandatory - This method must be implemented.

clearDescendantJournalTerms

void clearDescendantJournalTerms()

Clears the descendant journal terms.

Compliance:

mandatory - This method must be implemented.

getJournalQueryRecord

JournalQueryRecord getJournalQueryRecord(Type journalRecordType)
                                         throws OperationFailedException

Gets the journal query record corresponding to the given Journal record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

journalRecordType - a journal record type

Returns:

the journal query record

Throws:

NullArgumentException - journalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalRecordType) is false

Compliance:

mandatory - This method must be implemented.