public interface CompositionQuery extends OsidObjectQuery, OsidContainableQuery, OsidOperableQuery, OsidSourceableQuery
This is the query for searching compositions. Each method specifies an
AND
term while multiple invocations of the same method
produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAssetIdTerms()
Clears the asset
Id terms. |
void |
clearAssetTerms()
Clears the asset terms.
|
void |
clearContainedCompositionIdTerms()
Clears the contained composition
Id terms. |
void |
clearContainedCompositionTerms()
Clears the contained composition terms.
|
void |
clearContainingCompositionIdTerms()
Clears the containing composition
Id terms. |
void |
clearContainingCompositionTerms()
Clears the containing composition terms.
|
void |
clearRepositoryIdTerms()
Clears the repository
Id terms. |
void |
clearRepositoryTerms()
Clears the repository terms.
|
AssetQuery |
getAssetQuery()
Gets the query for an asset.
|
CompositionQueryRecord |
getCompositionQueryRecord(Type compositionRecordType)
Gets the composition query record corresponding to the given
Composition record Type. |
CompositionQuery |
getContainedCompositionQuery()
Gets the query for a composition.
|
CompositionQuery |
getContainingCompositionQuery()
Gets the query for a composition.
|
RepositoryQuery |
getRepositoryQuery()
Gets the query for a repository.
|
void |
matchAnyAsset(boolean match)
Matches compositions that has any asset mapping.
|
void |
matchAnyContainedComposition(boolean match)
Matches compositions that contain any other compositions.
|
void |
matchAnyContainingComposition(boolean match)
Matches compositions with any ancestor.
|
void |
matchAssetId(Id assetId,
boolean match)
Sets the asset
Id for this query. |
void |
matchContainedCompositionId(Id compositionId,
boolean match)
Sets the composition
Id for this query to match
compositions that contain the specified composition. |
void |
matchContainingCompositionId(Id compositionId,
boolean match)
Sets the composition
Id for this query to match
compositions that have the specified composition as an ancestor. |
void |
matchRepositoryId(Id repositoryId,
boolean match)
Sets the repository
Id for this query. |
boolean |
supportsAssetQuery()
Tests if an
AssetQuery is available. |
boolean |
supportsContainedCompositionQuery()
Tests if an
CompositionQuery is available. |
boolean |
supportsContainingCompositionQuery()
Tests if an
CompositionQuery is available. |
boolean |
supportsRepositoryQuery()
Tests if a
RepositoryQuery 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
clearSequesteredTerms, matchSequestered
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchAssetId(Id assetId, boolean match)
Id
for this query.assetId
- the asset Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- assetId
is
null
mandatory
- This method must be implemented. void clearAssetIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssetQuery()
AssetQuery
is available. true
if an asset query is available,
false
otherwisemandatory
- This method must be implemented. AssetQuery getAssetQuery()
OR
term.UnimplementedException
- supportsAssetQuery()
is false
optional
- This method must be implemented if
supportsAssetQuery()
is true.
void matchAnyAsset(boolean match)
match
- true
to match compositions with any
asset, false
to match compositions with no
assetmandatory
- This method must be implemented. void clearAssetTerms()
mandatory
- This method must be implemented. void matchContainingCompositionId(Id compositionId, boolean match)
Id
for this query to match
compositions that have the specified composition as an ancestor.compositionId
- a composition Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- compositionId
is
null
mandatory
- This method must be implemented. void clearContainingCompositionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsContainingCompositionQuery()
CompositionQuery
is available. true
if a composition query is available,
false
otherwisemandatory
- This method must be implemented. CompositionQuery getContainingCompositionQuery()
OR
term.UnimplementedException
-
supportsContainingCompositionQuery()
is false
optional
- This method must be implemented if
supportsContainingCompositionQuery()
is
true.
void matchAnyContainingComposition(boolean match)
match
- true
to match composition with any
ancestor, false
to match root compositionsmandatory
- This method must be implemented. void clearContainingCompositionTerms()
mandatory
- This method must be implemented. void matchContainedCompositionId(Id compositionId, boolean match)
Id
for this query to match
compositions that contain the specified composition.compositionId
- a composition Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- compositionId
is
null
mandatory
- This method must be implemented. void clearContainedCompositionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsContainedCompositionQuery()
CompositionQuery
is available. true
if a composition query is available,
false
otherwisemandatory
- This method must be implemented. CompositionQuery getContainedCompositionQuery()
OR
term.UnimplementedException
-
supportsContainedCompositionQuery()
is false
optional
- This method must be implemented if
supportsContainedCompositionQuery()
is
true.
void matchAnyContainedComposition(boolean match)
match
- true
to match composition with any
descendant, false
to match leaf compositionsmandatory
- This method must be implemented. void clearContainedCompositionTerms()
mandatory
- This method must be implemented. void matchRepositoryId(Id repositoryId, boolean match)
Id
for this query.repositoryId
- the repository Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- repositoryId
is
null
mandatory
- This method must be implemented. void clearRepositoryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRepositoryQuery()
RepositoryQuery
is available. true
if a repository query is available,
false
otherwisemandatory
- This method must be implemented. RepositoryQuery getRepositoryQuery()
OR
term.UnimplementedException
-
supportsRepositoryQuery()
is false
optional
- This method must be implemented if
supportsRepositoryQuery()
is true.
void clearRepositoryTerms()
mandatory
- This method must be implemented. CompositionQueryRecord getCompositionQueryRecord(Type compositionRecordType) throws OperationFailedException
Composition
record Type.
Multiple retrievals
produce a nested OR
term.compositionRecordType
- a composition record typeNullArgumentException
- compositionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionRecordType)
is false
mandatory
- This method must be implemented.