Interface CompositionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidContainableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Like all OsidQueries, CompositionQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidContainableQuery

clearSequesteredTerms, matchSequestered

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface 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 OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidSourceableQuery

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

Method Details

matchAssetId

void matchAssetId(Id assetId,
 boolean match)

Sets the asset Id for this query.

Parameters:

assetId - the asset Id

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

Throws:

NullArgumentException - assetId is null

Compliance:

mandatory - This method must be implemented.

clearAssetIdTerms

void clearAssetIdTerms()

Clears the asset Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssetQuery

boolean supportsAssetQuery()

Tests if an AssetQuery is available.

Returns:

true if an asset query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssetQuery

AssetQuery getAssetQuery()

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

Returns:

the asset query

Throws:

UnimplementedException - supportsAssetQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAssetQuery()} is {@code true}.

matchAnyAsset

void matchAnyAsset(boolean match)

Matches compositions that has any asset mapping.

Parameters:

match - true to match compositions with any asset, false to match compositions with no asset

Compliance:

mandatory - This method must be implemented.

clearAssetTerms

void clearAssetTerms()

Clears the asset terms.

Compliance:

mandatory - This method must be implemented.

matchContainingCompositionId

void matchContainingCompositionId(Id compositionId,
 boolean match)

Sets the composition Id for this query to match compositions that have the specified composition as an ancestor.

Parameters:

compositionId - a composition Id

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

Throws:

NullArgumentException - compositionId is null

Compliance:

mandatory - This method must be implemented.

clearContainingCompositionIdTerms

void clearContainingCompositionIdTerms()

Clears the containing composition Id terms.

Compliance:

mandatory - This method must be implemented.

supportsContainingCompositionQuery

boolean supportsContainingCompositionQuery()

Tests if an CompositionQuery is available.

Returns:

true if a composition query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContainingCompositionQuery

CompositionQuery getContainingCompositionQuery()

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

Returns:

the composition query

Throws:

UnimplementedException - supportsContainingCompositionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsContainingCompositionQuery()} is {@code true}.

matchAnyContainingComposition

void matchAnyContainingComposition(boolean match)

Matches compositions with any ancestor.

Parameters:

match - true to match composition with any ancestor, false to match root compositions

Compliance:

mandatory - This method must be implemented.

clearContainingCompositionTerms

void clearContainingCompositionTerms()

Clears the containing composition terms.

Compliance:

mandatory - This method must be implemented.

matchContainedCompositionId

void matchContainedCompositionId(Id compositionId,
 boolean match)

Sets the composition Id for this query to match compositions that contain the specified composition.

Parameters:

compositionId - a composition Id

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

Throws:

NullArgumentException - compositionId is null

Compliance:

mandatory - This method must be implemented.

clearContainedCompositionIdTerms

void clearContainedCompositionIdTerms()

Clears the contained composition Id terms.

Compliance:

mandatory - This method must be implemented.

supportsContainedCompositionQuery

boolean supportsContainedCompositionQuery()

Tests if an CompositionQuery is available.

Returns:

true if a composition query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContainedCompositionQuery

CompositionQuery getContainedCompositionQuery()

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

Returns:

the composition query

Throws:

UnimplementedException - supportsContainedCompositionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsContainedCompositionQuery()} is {@code true}.

matchAnyContainedComposition

void matchAnyContainedComposition(boolean match)

Matches compositions that contain any other compositions.

Parameters:

match - true to match composition with any descendant, false to match leaf compositions

Compliance:

mandatory - This method must be implemented.

clearContainedCompositionTerms

void clearContainedCompositionTerms()

Clears the contained composition terms.

Compliance:

mandatory - This method must be implemented.

matchRepositoryId

void matchRepositoryId(Id repositoryId,
 boolean match)

Sets the repository Id for this query.

Parameters:

repositoryId - the repository Id

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

Throws:

NullArgumentException - repositoryId is null

Compliance:

mandatory - This method must be implemented.

clearRepositoryIdTerms

void clearRepositoryIdTerms()

Clears the repository Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRepositoryQuery

boolean supportsRepositoryQuery()

Tests if a RepositoryQuery is available.

Returns:

true if a repository query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRepositoryQuery

RepositoryQuery getRepositoryQuery()

Gets the query for a repository. Multiple queries can be retrieved for a nested OR term.

Returns:

the repository query

Throws:

UnimplementedException - supportsRepositoryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRepositoryQuery()} is {@code true}.

clearRepositoryTerms

void clearRepositoryTerms()

Clears the repository terms.

Compliance:

mandatory - This method must be implemented.

getCompositionQueryRecord

CompositionQueryRecord getCompositionQueryRecord(Type compositionRecordType)
                                          throws OperationFailedException

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

Parameters:

compositionRecordType - a composition record type

Returns:

the composition query record

Throws:

NullArgumentException - compositionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionRecordType) is false

Compliance:

mandatory - This method must be implemented.