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.
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.
|
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchJournalEntryId(Id journalEntryId, boolean match)
Id
for this query to match
entries assigned to journals.matchJournalEntryId
in interface OsidObjectQuery
journalEntryId
- a journal entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- journalEntryId
is null
mandatory
- This method must be implemented. void clearJournalEntryIdTerms()
Id
terms.clearJournalEntryIdTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. boolean supportsJournalEntryQuery()
supportsJournalEntryQuery
in interface OsidObjectQuery
true
if a journal entry query is available,
false
otherwisemandatory
- This method must be implemented. JournalEntryQuery getJournalEntryQuery()
getJournalEntryQuery
in interface OsidObjectQuery
UnimplementedException
-
supportsJournalEntryQuery()
is false
optional
- This method must be implemented if
supportsJournalEntryQuery()
is true.
void matchAnyJournalEntry(boolean match)
matchAnyJournalEntry
in interface OsidObjectQuery
match
- true
to match journals with any journal
entry, false
to match journals with no entriesmandatory
- This method must be implemented. void clearJournalEntryTerms()
clearJournalEntryTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. void matchBranchId(Id branchId, boolean match)
Id
for this query to match branches
assigned to journals.branchId
- a branch Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- branchId
is
null
mandatory
- This method must be implemented. void clearBranchIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBranchQuery()
true
if a branch query is available,
false
otherwisemandatory
- This method must be implemented. BranchQuery getBranchQuery()
UnimplementedException
- supportsBranchQuery()
is false
optional
- This method must be implemented if
supportsBranchQuery()
is true.
void matchAnyBranch(boolean match)
match
- true
to match journals with any branch,
false
to match journals with no branchesmandatory
- This method must be implemented. void clearBranchTerms()
mandatory
- This method must be implemented. void matchAncestorJournalId(Id journalId, boolean match)
Id
for this query to match journals
that have the specified journal as an ancestor.journalId
- a journal Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- journalId
is
null
mandatory
- This method must be implemented. void clearAncestorJournalIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorJournalQuery()
JournalQuery
is available. true
if a journal query is available,
false
otherwisemandatory
- This method must be implemented. JournalQuery getAncestorJournalQuery()
OR
term.UnimplementedException
-
supportsAncestorJournalQuery()
is false
optional
- This method must be implemented if
supportsAncestorJournalQuery()
is true.
void matchAnyAncestorJournal(boolean match)
match
- true
to match journals with any ancestor,
false
to match root journalsmandatory
- This method must be implemented. void clearAncestorJournalTerms()
mandatory
- This method must be implemented. void matchDescendantJournalId(Id journalId, boolean match)
Id
for this query to match journals
that have the specified journal as a descendant.journalId
- a journal Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- journalId
is
null
mandatory
- This method must be implemented. void clearDescendantJournalIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantJournalQuery()
JournalQuery
is available. true
if a journal query is available,
false
otherwisemandatory
- This method must be implemented. JournalQuery getDescendantJournalQuery()
OR
term.UnimplementedException
-
supportsDescendantJournalQuery()
is false
optional
- This method must be implemented if
supportsDescendantJournalQuery()
is true.
void matchAnyDescendantJournal(boolean match)
match
- true
to match journals with any
descendant, false
to match leaf journalsmandatory
- This method must be implemented. void clearDescendantJournalTerms()
mandatory
- This method must be implemented. JournalQueryRecord getJournalQueryRecord(Type journalRecordType) throws OperationFailedException
Journal
record Type.
Multiple record retrievals
produce a nested boolean OR
term.journalRecordType
- a journal record typeNullArgumentException
- journalRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(journalRecordType)
is false
mandatory
- This method must be implemented.