org.osid.offering

Interface ParticipantQuery

All Superinterfaces:

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

public interface ParticipantQuery
extends OsidRelationshipQuery

This is the query for searching participants. 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	clearOfferingIdTerms() Clears all offering Id terms.
void	clearOfferingTerms() Clears all offering terms.
void	clearResourceIdTerms() Clears all resource Id terms.
void	clearResourceTerms() Clears all resource terms.
void	clearResultOptionIdTerms() Clears the grade system Id terms.
void	clearResultOptionTerms() Clears the grading option terms.
void	clearTimePeriodIdTerms() Clears the time period Id terms.
void	clearTimePeriodTerms() Clears the time period terms.
CatalogueQuery	getCatalogueQuery() Gets the query for a catalogue query.
OfferingQuery	getOfferingQuery() Gets the query for an offering query.
ParticipantQueryRecord	getParticipantQueryRecord(Type participantRecordType) Gets the participant query record corresponding to the given Participant record Type.
ResourceQuery	getResourceQuery() Gets the query for a resource query.
GradeSystemQuery	getResultOptionQuery() Gets the query for a grading option.
TimePeriodQuery	getTimePeriodQuery() Gets the query for a time period.
void	matchAnyResultOption(boolean match) Matches participants that have any grading option.
void	matchCatalogueId(Id catalogueId, boolean match) Sets the catalogue Id for this query to match participants assigned to catalogues.
void	matchOfferingId(Id offeringId, boolean match) Sets an offering Id.
void	matchResourceId(Id resourceId, boolean match) Sets a resource Id.
void	matchResultOptionId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
void	matchTimePeriodId(Id timePeriodId, boolean match) Sets the time period Id for this query to match participants that have a related term.
boolean	supportsCatalogueQuery() Tests if a CatalogueQuery is available.
boolean	supportsOfferingQuery() Tests if an OfferingQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available.
boolean	supportsResultOptionQuery() Tests if a GradeSystemQuery is available.
boolean	supportsTimePeriodQuery() Tests if a TimePeriodQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

matchOfferingId

void matchOfferingId(Id offeringId,
                   boolean match)

Sets an offering Id.

Parameters:

offeringId - an offering Id

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

Throws:

NullArgumentException - offeringId is null

Compliance:

mandatory - This method must be implemented.

clearOfferingIdTerms

void clearOfferingIdTerms()

Clears all offering Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOfferingQuery

boolean supportsOfferingQuery()

Tests if an OfferingQuery is available.

Returns:

true if an offering query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfferingQuery

OfferingQuery getOfferingQuery()

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

Returns:

the offering query

Throws:

UnimplementedException - supportsOfferingQuery() is false

Compliance:

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

clearOfferingTerms

void clearOfferingTerms()

Clears all offering terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets a resource Id.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears all resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears all resource terms.

Compliance:

mandatory - This method must be implemented.

matchTimePeriodId

void matchTimePeriodId(Id timePeriodId,
                     boolean match)

Sets the time period Id for this query to match participants that have a related term.

Parameters:

timePeriodId - a time period Id

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

Throws:

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearTimePeriodIdTerms

void clearTimePeriodIdTerms()

Clears the time period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTimePeriodQuery

boolean supportsTimePeriodQuery()

Tests if a TimePeriodQuery is available.

Returns:

true if a time period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodQuery

TimePeriodQuery getTimePeriodQuery()

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

Returns:

the time period query

Throws:

UnimplementedException - supportsTimePeriodQuery() is false

Compliance:

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

clearTimePeriodTerms

void clearTimePeriodTerms()

Clears the time period terms.

Compliance:

mandatory - This method must be implemented.

matchResultOptionId

void matchResultOptionId(Id gradeSystemId,
                       boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearResultOptionIdTerms

void clearResultOptionIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResultOptionQuery

boolean supportsResultOptionQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResultOptionQuery

GradeSystemQuery getResultOptionQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsResultOptionQuery() is false

Compliance:

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

matchAnyResultOption

void matchAnyResultOption(boolean match)

Matches participants that have any grading option.

Parameters:

match - true to match participants with any grading option, false to match participants with no grading options

Compliance:

mandatory - This method must be implemented.

clearResultOptionTerms

void clearResultOptionTerms()

Clears the grading option terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogueId

void matchCatalogueId(Id catalogueId,
                    boolean match)

Sets the catalogue Id for this query to match participants 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.

getParticipantQueryRecord

ParticipantQueryRecord getParticipantQueryRecord(Type participantRecordType)
                                                 throws OperationFailedException

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

Parameters:

participantRecordType - a participant record type

Returns:

the participant query record

Throws:

NullArgumentException - participantRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(participantRecordType) is false

Compliance:

mandatory - This method must be implemented.