org.osid.hold

Interface BlockQuery

All Superinterfaces:

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

public interface BlockQuery
extends OsidObjectQuery

This is the query for searching blocks. 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	clearIssueIdTerms() Clears the issue Id query terms.
void	clearIssueTerms() Clears the issue query terms.
void	clearOublietteIdTerms() Clears the oubliette Id query terms.
void	clearOublietteTerms() Clears the oubliette query terms.
BlockQueryRecord	getBlockQueryRecord(Type blockRecordType) Gets the block query record corresponding to the given Block record Type.
IssueQuery	getIssueQuery() Gets the query for an issue.
OublietteQuery	getOublietteQuery() Gets the query for an oubliette.
void	matchAnyIssue(boolean match) Matches blocks that have any issue.
void	matchIssueId(Id issueId, boolean match) Sets the issue Id for this query.
void	matchOublietteId(Id oublietteId, boolean match) Sets the oubliette Id for this query to match blocks assigned to foundries.
boolean	supportsIssueQuery() Tests if an IssueQuery 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

matchIssueId

void matchIssueId(Id issueId,
                boolean match)

Sets the issue Id for this query.

Parameters:

issueId - the issue Id

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

Throws:

NullArgumentException - issueId is null

Compliance:

mandatory - This method must be implemented.

clearIssueIdTerms

void clearIssueIdTerms()

Clears the issue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsIssueQuery

boolean supportsIssueQuery()

Tests if an IssueQuery is available.

Returns:

true if an issue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueQuery

IssueQuery getIssueQuery()

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

Returns:

the issue query

Throws:

UnimplementedException - supportsIssueQuery() is false

Compliance:

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

matchAnyIssue

void matchAnyIssue(boolean match)

Matches blocks that have any issue.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearIssueTerms

void clearIssueTerms()

Clears the issue 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 blocks 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.

getBlockQueryRecord

BlockQueryRecord getBlockQueryRecord(Type blockRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

blockRecordType - a block record type

Returns:

the block query record

Throws:

NullArgumentException - blockRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(blockRecordType) is false

Compliance:

mandatory - This method must be implemented.