org.osid.hold

Interface IssueQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface IssueQuery
extends OsidObjectQuery

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

Methods

Modifier and Type	Method and Description
void	clearBlockIdTerms() Clears the block Id query terms.
void	clearBlockTerms() Clears the block query terms.
void	clearBureauIdTerms() Clears the resource Id query terms.
void	clearBureauTerms() Clears the resource 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 resource.
HoldQuery	getHoldQuery() Gets the query for a hold.
IssueQueryRecord	getIssueQueryRecord(Type issueRecordType) Gets the issue query record corresponding to the given Issue record Type.
OublietteQuery	getOublietteQuery() Gets the query for an oubliette.
void	matchAnyBlock(boolean match) Matches issues used for any block.
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 resourceId, boolean match) Sets the resource 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 a OublietteQuery is available.

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchBureauId

void matchBureauId(Id resourceId,
                 boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearBureauIdTerms

void clearBureauIdTerms()

Clears the resource 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 resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if supportsResourceQuery() is true.

clearBureauTerms

void clearBureauTerms()

Clears the resource 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 supportsBlockQuery() is 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 supportsHoldQuery() is 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 a 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 supportsOublietteQuery() is 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.