Interface IssueQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface IssueQuery
extends OsidGovernatorQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearBlockIdTerms()	Clears the block Id query terms.
void	clearBlockTerms()	Clears the block query terms.
void	clearBureauIdTerms()	Clears the bureau Id query terms.
void	clearBureauTerms()	Clears the bureau query terms.
void	clearHoldIdTerms()	Clears the hold Id query terms.
void	clearHoldTerms()	Clears the hold query terms.
void	clearOublietteIdTerms()	Clears the oubliette Id query terms.
void	clearOublietteTerms()	Clears the oubliette query terms.
BlockQuery	getBlockQuery()	Gets the query for a block.
ResourceQuery	getBureauQuery()	Gets the query for a bureau.
HoldQuery	getHoldQuery()	Gets the query for a hold.
IssueQueryRecord	getIssueQueryRecord(Type issueRecordType)	Gets the issue query record corresponding to the given Issue record Type .Multiple record retrievals produce a nested OR term.
OublietteQuery	getOublietteQuery()	Gets the query for an oubliette.
void	matchAnyBlock(boolean match)	Matches issues used for any block.
void	matchAnyBureau(boolean match)	Matches issues with any bureau.
void	matchAnyHold(boolean match)	Matches issues referenced by any hold.
void	matchBlockId(Id blockId, boolean match)	Sets the block Id for this query.
void	matchBureauId(Id bureauId, boolean match)	Sets the bureau Id for this query.
void	matchHoldId(Id holdId, boolean match)	Sets the hold Id for this query.
void	matchOublietteId(Id oublietteId, boolean match)	Sets the oubliette Id for this query to match issues assigned to foundries.
boolean	supportsBlockQuery()	Tests if a BlockQuery is available.
boolean	supportsBureauQuery()	Tests if a ResourceQuery is available.
boolean	supportsHoldQuery()	Tests if a HoldQuery is available.
boolean	supportsOublietteQuery()	Tests if an OublietteQuery 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 OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

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

matchBureauId

void matchBureauId(Id bureauId,
 boolean match)

Sets the bureau Id for this query.

Parameters:

bureauId - the bureau Id

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

Throws:

NullArgumentException - bureauId is null

Compliance:

mandatory - This method must be implemented.

clearBureauIdTerms

void clearBureauIdTerms()

Clears the bureau Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBureauQuery

boolean supportsBureauQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBureauQuery

ResourceQuery getBureauQuery()

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

Returns:

the bureau query

Throws:

UnimplementedException - supportsBureauQuery() is false

Compliance:

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

matchAnyBureau

void matchAnyBureau(boolean match)

Matches issues with any bureau.

Parameters:

match - true to match issues with any bureaus, false to match issues with no bureaus

Compliance:

mandatory - This method must be implemented.

clearBureauTerms

void clearBureauTerms()

Clears the bureau query terms.

Compliance:

mandatory - This method must be implemented.

matchBlockId

void matchBlockId(Id blockId,
 boolean match)

Sets the block Id for this query.

Parameters:

blockId - the block Id

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

Throws:

NullArgumentException - blockId is null

Compliance:

mandatory - This method must be implemented.

clearBlockIdTerms

void clearBlockIdTerms()

Clears the block Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBlockQuery

boolean supportsBlockQuery()

Tests if a BlockQuery is available.

Returns:

true if a block query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBlockQuery

BlockQuery getBlockQuery()

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

Returns:

the block query

Throws:

UnimplementedException - supportsBlockQuery() is false

Compliance:

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

matchAnyBlock

void matchAnyBlock(boolean match)

Matches issues used for any block.

Parameters:

match - true to match issues with any blocks, false to match issues with no blocks

Compliance:

mandatory - This method must be implemented.

clearBlockTerms

void clearBlockTerms()

Clears the block query terms.

Compliance:

mandatory - This method must be implemented.

matchHoldId

void matchHoldId(Id holdId,
 boolean match)

Sets the hold Id for this query.

Parameters:

holdId - the hold Id

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

Throws:

NullArgumentException - holdId is null

Compliance:

mandatory - This method must be implemented.

clearHoldIdTerms

void clearHoldIdTerms()

Clears the hold Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsHoldQuery

boolean supportsHoldQuery()

Tests if a HoldQuery is available.

Returns:

true if a hold query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getHoldQuery

HoldQuery getHoldQuery()

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

Returns:

the hold query

Throws:

UnimplementedException - supportsHoldQuery() is false

Compliance:

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

matchAnyHold

void matchAnyHold(boolean match)

Matches issues referenced by any hold.

Parameters:

match - true to match issues with any holds, false to match issues with no holds

Compliance:

mandatory - This method must be implemented.

clearHoldTerms

void clearHoldTerms()

Clears the hold query terms.

Compliance:

mandatory - This method must be implemented.

matchOublietteId

void matchOublietteId(Id oublietteId,
 boolean match)

Sets the oubliette Id for this query to match issues assigned to foundries.

Parameters:

oublietteId - the oubliette Id

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

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

clearOublietteIdTerms

void clearOublietteIdTerms()

Clears the oubliette Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOublietteQuery

boolean supportsOublietteQuery()

Tests if an OublietteQuery is available.

Returns:

true if an oubliette query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOublietteQuery

OublietteQuery getOublietteQuery()

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

Returns:

the oubliette query

Throws:

UnimplementedException - supportsOublietteQuery() is false

Compliance:

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

clearOublietteTerms

void clearOublietteTerms()

Clears the oubliette query terms.

Compliance:

mandatory - This method must be implemented.

getIssueQueryRecord

IssueQueryRecord getIssueQueryRecord(Type issueRecordType)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

issueRecordType - an issue record type

Returns:

the issue query record

Throws:

NullArgumentException - issueRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(issueRecordType) is false

Compliance:

mandatory - This method must be implemented.