public interface ResultQuery extends OsidObjectQuery, OsidTemporalQuery, OsidSubjugateableQuery
This is the query for searching results. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCatalogueIdTerms()
Clears all catalogue
Id terms. |
void |
clearCatalogueTerms()
Clears all catalogue terms.
|
void |
clearGradeIdTerms()
Clears all grade
Id terms. |
void |
clearGradeTerms()
Clears all grade terms.
|
void |
clearParticipantIdTerms()
Clears all participant
Id terms. |
void |
clearParticipantTerms()
Clears all participant terms.
|
void |
clearValueTerms()
Clears all value terms.
|
CatalogueQuery |
getCatalogueQuery()
Gets the query for a catalogue query.
|
GradeQuery |
getGradeQuery()
Gets the query for a grade query.
|
ParticipantQuery |
getParticipantQuery()
Gets the query for a participant query.
|
ResultQueryRecord |
getResultQueryRecord(Type resultRecordType)
Gets the result query record corresponding to the given
Result
record Type. |
void |
matchAnyGrade(boolean match)
Matches results with any grade.
|
void |
matchAnyValue(boolean match)
Matches results with any value.
|
void |
matchCatalogueId(Id catalogueId,
boolean match)
Sets the catalogue
Id for this query to match results
assigned to catalogues. |
void |
matchGradeId(Id gradeId,
boolean match)
Sets a grade
Id. |
void |
matchParticipantId(Id participantId,
boolean match)
Sets a participant
Id. |
void |
matchValue(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches a value between the given range inclusive.
|
boolean |
supportsCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsGradeQuery()
Tests if a
GradetQuery is available. |
boolean |
supportsParticipantQuery()
Tests if a
ParticipantUnitQuery 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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchParticipantId(Id participantId, boolean match)
Id.
participantId
- a participant Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- participantId
is
null
mandatory
- This method must be implemented. void clearParticipantIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsParticipantQuery()
ParticipantUnitQuery
is available. true
if a participant query is available,
false
otherwisemandatory
- This method must be implemented. ParticipantQuery getParticipantQuery()
OR
term.UnimplementedException
-
supportsParticipantQuery()
is false
optional
- This method must be implemented if
supportsParticipantQuery()
is true.
void clearParticipantTerms()
mandatory
- This method must be implemented. void matchGradeId(Id gradeId, boolean match)
Id.
gradeId
- a grade Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearGradeIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradeQuery()
GradetQuery
is available. true
if a grade query is available,
false
otherwisemandatory
- This method must be implemented. GradeQuery getGradeQuery()
OR
term.UnimplementedException
- supportsGradeQuery()
is false
optional
- This method must be implemented if
supportsGradeQuery()
is true.
void matchAnyGrade(boolean match)
match
- true
to match results with any grade,
false
to match results with no grademandatory
- This method must be implemented. void clearGradeTerms()
mandatory
- This method must be implemented. void matchValue(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- a starting rangeto
- an ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
mandatory
- This method must be implemented. void matchAnyValue(boolean match)
match
- true
to match results with any value,
false
to match results with no valuemandatory
- This method must be implemented. void clearValueTerms()
mandatory
- This method must be implemented. void matchCatalogueId(Id catalogueId, boolean match)
Id
for this query to match results
assigned to catalogues.catalogueId
- a catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearCatalogueIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getCatalogueQuery()
OR
term.UnimplementedException
-
supportsCatalogueQuery()
is false
optional
- This method must be implemented if
supportsCatalogueQuery()
is true.
void clearCatalogueTerms()
mandatory
- This method must be implemented. ResultQueryRecord getResultQueryRecord(Type resultRecordType) throws OperationFailedException
Result
record Type.
Multiple record retrievals produce
a nested OR
term.resultRecordType
- an result record typeNullArgumentException
- resultRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resultRecordType)
is false
mandatory
- This method must be implemented.