Interface CandidateQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
This is the query inspector for examining candidate queries.
-
Method Summary
Modifier and TypeMethodDescriptiongetCandidateQueryInspectorRecord(Type candidateRecordType) Gets the candidate query inspector record corresponding to the givenCandidaterecordType.IdTerm[]Gets the pollsIdquery terms.Gets the polls query terms.IdTerm[]Gets the raceIdquery terms.Gets the race query terms.IdTerm[]Gets the resourceIdquery terms.Gets the resource query terms.IdTerm[]Gets the voteIdquery terms.Gets the vote query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reaosn state query terms.Methods inherited from interface OsidTemporalQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.
-
Method Details
-
getRaceIdTerms
IdTerm[] getRaceIdTerms()Gets the raceIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRaceTerms
RaceQueryInspector[] getRaceTerms()Gets the race query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getResourceIdTerms
IdTerm[] getResourceIdTerms()Gets the resourceIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getResourceTerms
ResourceQueryInspector[] getResourceTerms()Gets the resource query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVoteIdTerms
IdTerm[] getVoteIdTerms()Gets the voteIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVoteTerms
VoteQueryInspector[] getVoteTerms()Gets the vote query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getPollsIdTerms
IdTerm[] getPollsIdTerms()Gets the pollsIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getPollsTerms
PollsQueryInspector[] getPollsTerms()Gets the polls query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getCandidateQueryInspectorRecord
CandidateQueryInspectorRecord getCandidateQueryInspectorRecord(Type candidateRecordType) throws OperationFailedException Gets the candidate query inspector record corresponding to the givenCandidaterecordType.- Parameters:
candidateRecordType- a candidate record type- Returns:
- the candidate query inspector record
- Throws:
NullArgumentException-candidateRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(candidateRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-