Interface CandidateQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface CandidateQueryInspector extends OsidRelationshipQueryInspector

This is the query inspector for examining candidate queries.

  • Method Details

    • getRaceIdTerms

      IdTerm[] getRaceIdTerms()
      Gets the race Id query 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 resource Id query 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 vote Id query 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 polls Id query 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 given Candidate record Type .
      Parameters:
      candidateRecordType - a candidate record type
      Returns:
      the candidate query inspector record
      Throws:
      NullArgumentException - candidateRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(candidateRecordType) is false
      Compliance:
      mandatory - This method must be implemented.