Interface BallotQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector, OsidTemporalQueryInspector
public interface BallotQueryInspector
extends OsidGovernatorQueryInspector, OsidTemporalQueryInspector
This is the query inspector for examining ballot queries.
-
Method Summary
Modifier and TypeMethodDescriptiongetBallotQueryInspectorRecord(Type ballotRecordType) Gets the ballot query inspector record corresponding to the givenBallotrecordType.IdTerm[]Gets the commissionerIdquery terms.Gets the commissioner query terms.IdTerm[]Gets the pollsIdquery terms.Gets the polls query terms.IdTerm[]Gets the raceIdquery terms.Gets the race query terms.Gets the revote 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 OsidOperableQueryInspector
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTermsModifier and TypeMethodDescriptionGets the active query terms.Gets the administratively disabled query terms.Gets the administratively enabled query terms.Gets the operational query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidSourceableQueryInspector
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTermsMethods 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
-
getCommissionerIdTerms
IdTerm[] getCommissionerIdTerms()Gets the commissionerIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getCommissionerTerms
ResourceQueryInspector[] getCommissionerTerms()Gets the commissioner query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRevoteTerms
BooleanTerm[] getRevoteTerms()Gets the revote query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
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.
-
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.
-
getBallotQueryInspectorRecord
BallotQueryInspectorRecord getBallotQueryInspectorRecord(Type ballotRecordType) throws OperationFailedException Gets the ballot query inspector record corresponding to the givenBallotrecordType.- Parameters:
ballotRecordType- a ballot record type- Returns:
- the ballot query inspector record
- Throws:
NullArgumentException-ballotRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(ballotRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-