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.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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 matchOfferingId(Id offeringId, boolean match)
Id.
offeringId
- an offering Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- offeringId
is
null
mandatory
- This method must be implemented. void clearOfferingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsOfferingQuery()
OfferingQuery
is available. true
if an offering query is available,
false
otherwisemandatory
- This method must be implemented. OfferingQuery getOfferingQuery()
OR
term.UnimplementedException
- supportsOfferingQuery()
is false
optional
- This method must be implemented if
supportsOfferingQuery()
is true.
void clearOfferingTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id.
resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchTimePeriodId(Id timePeriodId, boolean match)
Id
for this query to match
participants that have a related term.timePeriodId
- a time period Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- timePeriodId
is
null
mandatory
- This method must be implemented. void clearTimePeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTimePeriodQuery()
TimePeriodQuery
is available. true
if a time period query is available,
false
otherwisemandatory
- This method must be implemented. TimePeriodQuery getTimePeriodQuery()
OR
term.UnimplementedException
-
supportsTimePeriodQuery()
is false
optional
- This method must be implemented if
supportsTimePeriodQuery()
is true.
void clearTimePeriodTerms()
mandatory
- This method must be implemented. void matchResultOptionId(Id gradeSystemId, boolean match)
Id
for this query.gradeSystemId
- a grade system Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearResultOptionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResultOptionQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getResultOptionQuery()
OR
term.UnimplementedException
-
supportsResultOptionQuery()
is false
optional
- This method must be implemented if
supportsGradingOptionQuery()
is true.
void matchAnyResultOption(boolean match)
match
- true
to match participants with any
grading option, false
to match participants
with no grading optionsmandatory
- This method must be implemented. void clearResultOptionTerms()
mandatory
- This method must be implemented. void matchCatalogueId(Id catalogueId, boolean match)
Id
for this query to match
participants 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. ParticipantQueryRecord getParticipantQueryRecord(Type participantRecordType) throws OperationFailedException
Participant
record Type.
Multiple record
retrievals produce a nested OR
term.participantRecordType
- a participant record typeNullArgumentException
- participantRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(participantRecordType)
is false
mandatory
- This method must be implemented.