public interface OsidCompendiumQuery extends OsidObjectQuery, OsidSubjugateableQuery
This is the query interface for searching reports. Each method
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearEndDateTerms()
Clears the end date query terms.
|
void |
clearExtrapolatedTerms()
Clears the extrapolated query terms.
|
void |
clearInterpolatedTerms()
Clears the interpolated query terms.
|
void |
clearStartDateTerms()
Clears the start date query terms.
|
void |
matchAnyEndDate(boolean match)
Matches reports with any end date set.
|
void |
matchAnyStartDate(boolean match)
Matches reports with any start date set.
|
void |
matchEndDate(DateTime start,
DateTime end,
boolean match)
Matches reports whose effective end date falls in between the given
dates inclusive.
|
void |
matchExtrapolated(boolean match)
Match reports that are extrapolated.
|
void |
matchInterpolated(boolean match)
Match reports that are interpolated.
|
void |
matchStartDate(DateTime start,
DateTime end,
boolean match)
Matches reports whose start date falls in between the given dates
inclusive.
|
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
void matchStartDate(DateTime start, DateTime end, boolean match)
start
- start of date rangeend
- end of date rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- start
is less
than end
NullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void matchAnyStartDate(boolean match)
match
- true
to match any start date,
false
to match no start datemandatory
- This method must be implemented. void clearStartDateTerms()
mandatory
- This method must be implemented. void matchEndDate(DateTime start, DateTime end, boolean match)
start
- start of date rangeend
- end of date rangematch
- true
if a positive match, false
for negative matchInvalidArgumentException
- start
is less
than end
NullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void matchAnyEndDate(boolean match)
match
- true
to match any end date, false
to match no start datemandatory
- This method must be implemented. void clearEndDateTerms()
mandatory
- This method must be implemented. void matchInterpolated(boolean match)
match
- true
to match any interpolated reports,
false
to match non-interpolated reportsmandatory
- This method must be implemented. void clearInterpolatedTerms()
mandatory
- This method must be implemented. void matchExtrapolated(boolean match)
match
- true
to match any extrapolated reports,
false
to match non-extrapolated reportsmandatory
- This method must be implemented. void clearExtrapolatedTerms()
mandatory
- This method must be implemented.