public interface LogQuery extends OsidCatalogQuery
This is the query for searching for logs. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorLogIdTerms()
Clesrs the ancestor log
Id terms. |
void |
clearAncestorLogTerms()
Clesrs the ancestor log terms.
|
void |
clearDescendantLogIdTerms()
Clesrs the descendant log
Id terms. |
void |
clearDescendantLogTerms()
Clesrs the descendant log terms.
|
void |
clearLogEntryIdTerms()
Clesrs the log entry
Id terms. |
void |
clearLogEntryTerms()
Clesrs the log entry terms.
|
LogQuery |
getAncestorLogQuery()
Gets the query for a log.
|
LogQuery |
getDescendantLogQuery()
Gets the query for a log.
|
LogEntryQuery |
getLogEntryQuery()
Gets the query for a log entry.
|
LogQueryRecord |
getLogQueryRecord(Type logRecordType)
Gets the log query record corresponding to the given
Log
record Type. |
void |
matchAncestorLogId(Id logId,
boolean match)
Sets the log
Id for this query to match logs that have
the specified log as an ancestor. |
void |
matchAnyAncestorLog(boolean match)
Matches logs with any ancestor.
|
void |
matchAnyDescendantLog(boolean match)
Matches logs with any descendant.
|
void |
matchAnyLogEntry(boolean match)
Matches logs with any log entry.
|
void |
matchDescendantLogId(Id logId,
boolean match)
Sets the log
Id for this query to match logs that have
the specified log as a descendant. |
void |
matchLogEntryId(Id logEntryId,
boolean match)
Sets a log entry
Id. |
boolean |
supportsAncestorLogQuery()
Tests if a
LogQuery is available. |
boolean |
supportsDescendantLogQuery()
Tests if a
LogQuery is available. |
boolean |
supportsLogEntryQuery()
Tests if a log entry query is available.
|
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
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 matchLogEntryId(Id logEntryId, boolean match)
Id.
logEntryId
- a log entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- logEntryId
is
null
mandatory
- This method must be implemented. void clearLogEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLogEntryQuery()
true
if a log entry query is available,
false
otherwisemandatory
- This method must be implemented. LogEntryQuery getLogEntryQuery()
UnimplementedException
- supportsLogEntryQuery()
is false
optional
- This method must be implemented if
supportsLogEntryQuery()
is true.
void matchAnyLogEntry(boolean match)
match
- true
to match logs with any entry,
false
to match logs with no log entriesmandatory
- This method must be implemented. void clearLogEntryTerms()
mandatory
- This method must be implemented. void matchAncestorLogId(Id logId, boolean match)
Id
for this query to match logs that have
the specified log as an ancestor.logId
- a log Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- logId
is
null
mandatory
- This method must be implemented. void clearAncestorLogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorLogQuery()
LogQuery
is available. true
if a log query is available, false
otherwisemandatory
- This method must be implemented. LogQuery getAncestorLogQuery()
OR
term.UnimplementedException
-
supportsAncestorLogQuery()
is false
optional
- This method must be implemented if
supportsAncestorLogQuery()
is true.
void matchAnyAncestorLog(boolean match)
match
- true
to match logs with any ancestor,
false
to match root logsmandatory
- This method must be implemented. void clearAncestorLogTerms()
mandatory
- This method must be implemented. void matchDescendantLogId(Id logId, boolean match)
Id
for this query to match logs that have
the specified log as a descendant.logId
- a log Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- logId
is
null
mandatory
- This method must be implemented. void clearDescendantLogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantLogQuery()
LogQuery
is available. true
if a log query is available, false
otherwisemandatory
- This method must be implemented. LogQuery getDescendantLogQuery()
OR
term.UnimplementedException
-
supportsDescendantLogQuery()
is false
optional
- This method must be implemented if
supportsDescendantLogQuery()
is true.
void matchAnyDescendantLog(boolean match)
match
- true
to match logs with any descendant,
false
to match leaf logsmandatory
- This method must be implemented. void clearDescendantLogTerms()
mandatory
- This method must be implemented. LogQueryRecord getLogQueryRecord(Type logRecordType) throws OperationFailedException
Log
record Type.
Multiple record retrievals produce
a nested boolean OR
term.logRecordType
- a log record typeNullArgumentException
- logRecordType
is
null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(logRecordType)
is false
mandatory
- This method must be implemented.