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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchBlockId(Id blockId, boolean match)
Id
for this query to match oubliettes
containing blocks.blockId
- the block Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- blockId
is
null
mandatory
- This method must be implemented. void clearBlockIdTerms()
mandatory
- This method must be implemented. boolean supportsBlockQuery()
BlockQuery
is available. true
if a block query is available,
false
otherwisemandatory
- This method must be implemented. BlockQuery getBlockQuery()
OR
term.UnimplementedException
- supportsBlockQuery()
is false
optional
- This method must be implemented if
supportsBlockQuery()
is true.
void matchAnyBlock(boolean match)
match
- true
to match oubliettes with any block,
false
to match oubliettes with no blockmandatory
- This method must be implemented. void clearBlockTerms()
mandatory
- This method must be implemented. void matchIssueId(Id issueId, boolean match)
Id
for this query to match oubliettes
that have a related issue.issueId
- a issue Id
match
- true
if a positive match, false
for negative matchNullArgumentException
- issueId
is
null
mandatory
- This method must be implemented. void clearIssueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsIssueQuery()
IssueQuery
is available. true
if a issue query is available,
false
otherwisemandatory
- This method must be implemented. IssueQuery getIssueQuery()
OR
term.UnimplementedException
- supportsIssueQuery()
is false
optional
- This method must be implemented if
supportsIssueQuery()
is true.
void matchAnyIssue(boolean match)
match
- true
to match oubliettes with any issue,
false
to match oubliettes with no issuemandatory
- This method must be implemented. void clearIssueTerms()
mandatory
- This method must be implemented. void matchHoldId(Id holdId, boolean match)
Id
for this query.holdId
- the hold Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- holdId
is
null
mandatory
- This method must be implemented. void clearHoldIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsHoldQuery()
HoldQuery
is available. true
if a hold query is available, false
otherwisemandatory
- This method must be implemented. HoldQuery getHoldQuery()
OR
term.UnimplementedException
- supportsHoldQuery()
is false
optional
- This method must be implemented if
supportsHoldQuery()
is true.
void matchAnyHold(boolean match)
match
- true
to match oubliettes with any holds,
false
to match oubliettes with no holdsmandatory
- This method must be implemented. void clearHoldTerms()
mandatory
- This method must be implemented. void matchAncestorOublietteId(Id oublietteId, boolean match)
Id
for this query to match
oubliettes that have the specified oubliette as an ancestor.oublietteId
- an oubliette Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- oublietteId
is
null
mandatory
- This method must be implemented. void clearAncestorOublietteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorOublietteQuery()
OublietteQuery
is available. true
if an oubliette query is available,
false
otherwisemandatory
- This method must be implemented. OublietteQuery getAncestorOublietteQuery()
OR
term.UnimplementedException
-
supportsAncestorOublietteQuery()
is false
optional
- This method must be implemented if
supportsAncestorOublietteQuery()
is true.
void matchAnyAncestorOubliette(boolean match)
match
- true
to match oubliettes with any
ancestor, false
to match root oubliettesmandatory
- This method must be implemented. void clearAncestorOublietteTerms()
mandatory
- This method must be implemented. void matchDescendantOublietteId(Id oublietteId, boolean match)
Id
for this query to match
oubliettes that have the specified oubliette as a descendant.oublietteId
- an oubliette Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- oublietteId
is
null
mandatory
- This method must be implemented. void clearDescendantOublietteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantOublietteQuery()
OublietteQuery
is available. true
if an oubliette query is available,
false
otherwisemandatory
- This method must be implemented. OublietteQuery getDescendantOublietteQuery()
OR
term.UnimplementedException
-
supportsDescendantOublietteQuery()
is false
optional
- This method must be implemented if
supportsDescendantOublietteQuery()
is true.
void matchAnyDescendantOubliette(boolean match)
match
- true
to match oubliettes with any
descendant, false
to match leaf oubliettesmandatory
- This method must be implemented. void clearDescendantOublietteTerms()
mandatory
- This method must be implemented. OublietteQueryRecord getOublietteQueryRecord(Type oublietteRecordType) throws OperationFailedException, PermissionDeniedException
Oubliette
record Type.
Multiple record
retrievals produce a nested OR
term.oublietteRecordType
- an oubliette record typeNullArgumentException
- oublietteRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(oublietteRecordType)
is false
mandatory
- This method must be implemented.