Interface PollsQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface PollsQuery
extends OsidCatalogQuery

This is the query for searching polls. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorPollsIdTerms()	Clears the ancestor polls Id terms.
void	clearAncestorPollsTerms()	Clears the ancestor polls terms.
void	clearCandidateIdTerms()	Clears the candidate Id terms.
void	clearCandidateTerms()	Clears the candidate terms.
void	clearDescendantPollsIdTerms()	Clears the descendant polls Id terms.
void	clearDescendantPollsTerms()	Clears the descendant polls terms.
PollsQuery	getAncestorPollsQuery()	Gets the query for a polls.
CandidateQuery	getCandidateQuery()	Gets the query for a candidate.
PollsQuery	getDescendantPollsQuery()	Gets the query for a polls.
PollsQueryRecord	getPollsQueryRecord(Type pollsRecordType)	Gets the polls query record corresponding to the given Polls record Type .Multiple retrievals produce a nested OR term.
void	matchAncestorPollsId(Id pollsid, boolean match)	Sets the polls Id for this query to match polls that have the specified polls as an ancestor.
void	matchAnyAncestorPolls(boolean match)	Matches polls with any ancestor.
void	matchAnyCandidate(boolean match)	Matches polls with any candidate.
void	matchAnyDescendantPolls(boolean match)	Matches polls with any descendant.
void	matchCandidateId(Id candidateId, boolean match)	Sets the candidate Id for this query.
void	matchDescendantPollsId(Id pollsid, boolean match)	Sets the polls Id for this query to match polls that have the specified polls as a descendant.
boolean	supportsAncestorPollsQuery()	Tests if a PollsQuery is available.
boolean	supportsCandidateQuery()	Tests if a CandidateQuery is available.
boolean	supportsDescendantPollsQuery()	Tests if a PollsQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchCandidateId

void matchCandidateId(Id candidateId,
 boolean match)

Sets the candidate Id for this query.

Parameters:

candidateId - a candidate Id

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

Throws:

NullArgumentException - candidateId is null

Compliance:

mandatory - This method must be implemented.

clearCandidateIdTerms

void clearCandidateIdTerms()

Clears the candidate Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCandidateQuery

boolean supportsCandidateQuery()

Tests if a CandidateQuery is available.

Returns:

true if a candidate query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCandidateQuery

CandidateQuery getCandidateQuery()

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

Returns:

the candidate query

Throws:

UnimplementedException - supportsCandidateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCandidateQuery()} is {@code true} .

matchAnyCandidate

void matchAnyCandidate(boolean match)

Matches polls with any candidate.

Parameters:

match - true to match polls with any candidate, false to match polls with no candidates

Compliance:

mandatory - This method must be implemented.

clearCandidateTerms

void clearCandidateTerms()

Clears the candidate terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorPollsId

void matchAncestorPollsId(Id pollsid,
 boolean match)

Sets the polls Id for this query to match polls that have the specified polls as an ancestor.

Parameters:

pollsid - a polls Id

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

Throws:

NullArgumentException - pollsId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorPollsIdTerms

void clearAncestorPollsIdTerms()

Clears the ancestor polls Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorPollsQuery

boolean supportsAncestorPollsQuery()

Tests if a PollsQuery is available.

Returns:

true if a polls query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorPollsQuery

PollsQuery getAncestorPollsQuery()

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

Returns:

the polls query

Throws:

UnimplementedException - supportsAncestorPollsQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorPollsQuery()} is {@code true} .

matchAnyAncestorPolls

void matchAnyAncestorPolls(boolean match)

Matches polls with any ancestor.

Parameters:

match - true to match polls with any ancestor, false to match root polls

Compliance:

mandatory - This method must be implemented.

clearAncestorPollsTerms

void clearAncestorPollsTerms()

Clears the ancestor polls terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantPollsId

void matchDescendantPollsId(Id pollsid,
 boolean match)

Sets the polls Id for this query to match polls that have the specified polls as a descendant.

Parameters:

pollsid - a polls Id

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

Throws:

NullArgumentException - pollsId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantPollsIdTerms

void clearDescendantPollsIdTerms()

Clears the descendant polls Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantPollsQuery

boolean supportsDescendantPollsQuery()

Tests if a PollsQuery is available.

Returns:

true if a polls query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantPollsQuery

PollsQuery getDescendantPollsQuery()

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

Returns:

the polls query

Throws:

UnimplementedException - supportsDescendantPollsQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantPollsQuery()} is {@code true} .

matchAnyDescendantPolls

void matchAnyDescendantPolls(boolean match)

Matches polls with any descendant.

Parameters:

match - true to match polls with any descendant, false to match leaf polls

Compliance:

mandatory - This method must be implemented.

clearDescendantPollsTerms

void clearDescendantPollsTerms()

Clears the descendant polls terms.

Compliance:

mandatory - This method must be implemented.

getPollsQueryRecord

PollsQueryRecord getPollsQueryRecord(Type pollsRecordType)
                              throws OperationFailedException

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

Parameters:

pollsRecordType - a polls record type

Returns:

the polls query record

Throws:

NullArgumentException - pollsRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pollsRecordType) is false

Compliance:

mandatory - This method must be implemented.