org.osid.hold

Interface OublietteQuery

All Superinterfaces:

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

public interface OublietteQuery
extends OsidCatalogQuery

This is the query for searching oubliettes. 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	clearAncestorOublietteIdTerms() Clears the ancestor oubliette Id query terms.
void	clearAncestorOublietteTerms() Clears the ancestor oubliette query terms.
void	clearBlockIdTerms() Clears the block query terms.
void	clearBlockTerms() Clears the block query terms.
void	clearDescendantOublietteIdTerms() Clears the descendant oubliette Id query terms.
void	clearDescendantOublietteTerms() Clears the descendant oubliette query terms.
void	clearHoldIdTerms() Clears the hold Id query terms.
void	clearHoldTerms() Clears the hold query terms.
void	clearIssueIdTerms() Clears the issue Id query terms.
void	clearIssueTerms() Clears the issue query terms.
OublietteQuery	getAncestorOublietteQuery() Gets the query for an oubliette.
BlockQuery	getBlockQuery() Gets the query for a block.
OublietteQuery	getDescendantOublietteQuery() Gets the query for an oubliette/ Multiple retrievals produce a nested OR term.
HoldQuery	getHoldQuery() Gets the query for a hold.
IssueQuery	getIssueQuery() Gets the query for a issue.
OublietteQueryRecord	getOublietteQueryRecord(Type oublietteRecordType) Gets the oubliette query record corresponding to the given Oubliette record Type.
void	matchAncestorOublietteId(Id oublietteId, boolean match) Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as an ancestor.
void	matchAnyAncestorOubliette(boolean match) Matches oubliettes with any ancestor.
void	matchAnyBlock(boolean match) Matches oubliettes that have any block.
void	matchAnyDescendantOubliette(boolean match) Matches oubliettes with any descendant.
void	matchAnyHold(boolean match) Matches oubliettes referenced by any hold.
void	matchAnyIssue(boolean match) Matches oubliettes that have any issue.
void	matchBlockId(Id blockId, boolean match) Sets the effort Id for this query to match oubliettes containing blocks.
void	matchDescendantOublietteId(Id oublietteId, boolean match) Sets the oubliette Id for this query to match oubliettes that have the specified oubliette as a descendant.
void	matchHoldId(Id holdId, boolean match) Sets the hold Id for this query.
void	matchIssueId(Id issueId, boolean match) Sets the issue Id for this query to match oubliettes that have a related issue.
boolean	supportsAncestorOublietteQuery() Tests if an OublietteQuery is available.
boolean	supportsBlockQuery() Tests if a BlockQuery is available.
boolean	supportsDescendantOublietteQuery() Tests if an OublietteQuery is available.
boolean	supportsHoldQuery() Tests if a HoldQuery is available.
boolean	supportsIssueQuery() Tests if a IssueQuery 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

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

matchBlockId

void matchBlockId(Id blockId,
                boolean match)

Sets the effort Id for this query to match oubliettes containing blocks.

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 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 oubliettes that have any block.

Parameters:

match - true to match oubliettes with any block, false to match oubliettes with no block

Compliance:

mandatory - This method must be implemented.

clearBlockTerms

void clearBlockTerms()

Clears the block query terms.

Compliance:

mandatory - This method must be implemented.

matchIssueId

void matchIssueId(Id issueId,
                boolean match)

Sets the issue Id for this query to match oubliettes that have a related issue.

Parameters:

issueId - a issue Id

match - true if a positive match, false for 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 a IssueQuery is available.

Returns:

true if a issue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueQuery

IssueQuery getIssueQuery()

Gets the query for a 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 oubliettes that have any issue.

Parameters:

match - true to match oubliettes with any issue, false to match oubliettes 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.

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 oubliettes referenced by any hold.

Parameters:

match - true to match oubliettes with any holds, false to match oubliettes 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.

matchAncestorOublietteId

void matchAncestorOublietteId(Id oublietteId,
                            boolean match)

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

Parameters:

oublietteId - an oubliette Id

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

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorOublietteIdTerms

void clearAncestorOublietteIdTerms()

Clears the ancestor oubliette Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorOublietteQuery

boolean supportsAncestorOublietteQuery()

Tests if an OublietteQuery is available.

Returns:

true if an oubliette query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorOublietteQuery

OublietteQuery getAncestorOublietteQuery()

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

Returns:

the oubliette query

Throws:

UnimplementedException - supportsAncestorOublietteQuery() is false

Compliance:

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

matchAnyAncestorOubliette

void matchAnyAncestorOubliette(boolean match)

Matches oubliettes with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorOublietteTerms

void clearAncestorOublietteTerms()

Clears the ancestor oubliette query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantOublietteId

void matchDescendantOublietteId(Id oublietteId,
                              boolean match)

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

Parameters:

oublietteId - an oubliette Id

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

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantOublietteIdTerms

void clearDescendantOublietteIdTerms()

Clears the descendant oubliette Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantOublietteQuery

boolean supportsDescendantOublietteQuery()

Tests if an OublietteQuery is available.

Returns:

true if an oubliette query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantOublietteQuery

OublietteQuery getDescendantOublietteQuery()

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

Returns:

the oubliette query

Throws:

UnimplementedException - supportsDescendantOublietteQuery() is false

Compliance:

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

matchAnyDescendantOubliette

void matchAnyDescendantOubliette(boolean match)

Matches oubliettes with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantOublietteTerms

void clearDescendantOublietteTerms()

Clears the descendant oubliette query terms.

Compliance:

mandatory - This method must be implemented.

getOublietteQueryRecord

OublietteQueryRecord getOublietteQueryRecord(Type oublietteRecordType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

oublietteRecordType - an oubliette record type

Returns:

the oubliette query record

Throws:

NullArgumentException - oublietteRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(oublietteRecordType) is false

Compliance:

mandatory - This method must be implemented.