org.osid.offering

Interface ResultQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchParticipantId

void matchParticipantId(Id participantId,
                      boolean match)

Sets a participant Id.

Parameters:

participantId - a participant Id

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

Throws:

NullArgumentException - participantId is null

Compliance:

mandatory - This method must be implemented.

clearParticipantIdTerms

void clearParticipantIdTerms()

Clears all participant Id terms.

Compliance:

mandatory - This method must be implemented.

supportsParticipantQuery

boolean supportsParticipantQuery()

Tests if a ParticipantUnitQuery is available.

Returns:

true if a participant query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParticipantQuery

ParticipantQuery getParticipantQuery()

Gets the query for a participant query. Multiple retrievals produce a nested OR term.

Returns:

the participant query

Throws:

UnimplementedException - supportsParticipantQuery() is false

Compliance:

optional - This method must be implemented if supportsParticipantQuery() is true.

clearParticipantTerms

void clearParticipantTerms()

Clears all participant terms.

Compliance:

mandatory - This method must be implemented.

matchGradeId

void matchGradeId(Id gradeId,
                boolean match)

Sets a grade Id.

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearGradeIdTerms

void clearGradeIdTerms()

Clears all grade Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeQuery

boolean supportsGradeQuery()

Tests if a GradetQuery is available.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeQuery

GradeQuery getGradeQuery()

Gets the query for a grade query. Multiple retrievals produce a nested OR term.

Returns:

the grade query

Throws:

UnimplementedException - supportsGradeQuery() is false

Compliance:

optional - This method must be implemented if supportsGradeQuery() is true.

matchAnyGrade

void matchAnyGrade(boolean match)

Matches results with any grade.

Parameters:

match - true to match results with any grade, false to match results with no grade

Compliance:

mandatory - This method must be implemented.

clearGradeTerms

void clearGradeTerms()

Clears all grade terms.

Compliance:

mandatory - This method must be implemented.

matchValue

void matchValue(java.math.BigDecimal from,
              java.math.BigDecimal to,
              boolean match)

Matches a value between the given range inclusive.

Parameters:

from - a starting range

to - an ending range

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

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnyValue

void matchAnyValue(boolean match)

Matches results with any value.

Parameters:

match - true to match results with any value, false to match results with no value

Compliance:

mandatory - This method must be implemented.

clearValueTerms

void clearValueTerms()

Clears all value terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogueId

void matchCatalogueId(Id catalogueId,
                    boolean match)

Sets the catalogue Id for this query to match results assigned to catalogues.

Parameters:

catalogueId - a catalogue Id

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

Throws:

NullArgumentException - catalogueId is null

Compliance:

mandatory - This method must be implemented.

clearCatalogueIdTerms

void clearCatalogueIdTerms()

Clears all catalogue Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCatalogueQuery

boolean supportsCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogueQuery

CatalogueQuery getCatalogueQuery()

Gets the query for a catalogue query. Multiple retrievals produce a nested OR term.

Returns:

the catalogue query

Throws:

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

optional - This method must be implemented if supportsCatalogueQuery() is true.

clearCatalogueTerms

void clearCatalogueTerms()

Clears all catalogue terms.

Compliance:

mandatory - This method must be implemented.

getResultQueryRecord

ResultQueryRecord getResultQueryRecord(Type resultRecordType)
                                       throws OperationFailedException

Gets the result query record corresponding to the given Result record Type. Multiple record retrievals produce a nested OR term.

Parameters:

resultRecordType - an result record type

Returns:

the result query record

Throws:

NullArgumentException - resultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultRecordType) is false

Compliance:

mandatory - This method must be implemented.