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 .

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

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidContainableQuery

clearSequesteredTerms, matchSequestered

Modifier and Type	Method	Description
void	clearSequesteredTerms()	Clears the sequestered query terms.
void	matchSequestered(boolean match)	Match containables that are sequestered.

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

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

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

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.