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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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(BigDecimal from, 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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsParticipantQuery()} is {@code 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 {@code supportsGradeQuery()} is {@code 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(BigDecimal from,
 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 {@code supportsCatalogueQuery()} is {@code 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 - a 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.