org.osid

Interface OsidCompendiumQuery

All Superinterfaces:

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

All Known Subinterfaces:

StatisticQuery, SummaryQuery

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.

Method Summary

Methods

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.

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

Method Detail

matchStartDate

void matchStartDate(DateTime start,
                  DateTime end,
                  boolean match)

Matches reports whose start date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

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

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyStartDate

void matchAnyStartDate(boolean match)

Matches reports with any start date set.

Parameters:

match - true to match any start date, false to match no start date

Compliance:

mandatory - This method must be implemented.

clearStartDateTerms

void clearStartDateTerms()

Clears the start date query terms.

Compliance:

mandatory - This method must be implemented.

matchEndDate

void matchEndDate(DateTime start,
                DateTime end,
                boolean match)

Matches reports whose effective end date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

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

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyEndDate

void matchAnyEndDate(boolean match)

Matches reports with any end date set.

Parameters:

match - true to match any end date, false to match no start date

Compliance:

mandatory - This method must be implemented.

clearEndDateTerms

void clearEndDateTerms()

Clears the end date query terms.

Compliance:

mandatory - This method must be implemented.

matchInterpolated

void matchInterpolated(boolean match)

Match reports that are interpolated.

Parameters:

match - true to match any interpolated reports, false to match non-interpolated reports

Compliance:

mandatory - This method must be implemented.

clearInterpolatedTerms

void clearInterpolatedTerms()

Clears the interpolated query terms.

Compliance:

mandatory - This method must be implemented.

matchExtrapolated

void matchExtrapolated(boolean match)

Match reports that are extrapolated.

Parameters:

match - true to match any extrapolated reports, false to match non-extrapolated reports

Compliance:

mandatory - This method must be implemented.

clearExtrapolatedTerms

void clearExtrapolatedTerms()

Clears the extrapolated query terms.

Compliance:

mandatory - This method must be implemented.