Interface ConfigurationQuery

All Superinterfaces:

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

public interface ConfigurationQuery
extends OsidCatalogQuery

This is the query for searching configurations. Each method match request produces an AND term while multiple invocations of a method produces a nested OR , except for accessing the ConfigurationQuery subinterface.

Method Summary

Modifier and Type	Method	Description
void	clearAncestorConfigurationIdTerms()	Clears the ancestor configuration Id terms.
void	clearAncestorConfigurationTerms()	Clears the ancestor configuration terms.
void	clearDescendantConfigurationIdTerms()	Clears the descendant configuration Id terms.
void	clearDescendantConfigurationTerms()	Clears the descendant configuration terms.
void	clearParameterIdTerms()	Clears the parameter Id terms.
void	clearParameterTerms()	Clears the parameter terms.
void	clearRegistryTerms()	Clears the registry terms.
ConfigurationQuery	getAncestorConfigurationQuery()	Gets the query interface for a configuration.
ConfigurationQueryRecord	getConfigurationQueryRecord(Type configurationRecordType)	Gets the configuration query record corresponding to the given Configuration record Type .
ConfigurationQuery	getDescendantConfigurationQuery()	Gets the query interface for a configuration.
ParameterQuery	getParameterQuery()	Gets the query interface for a parameter.
void	matchAncestorConfigurationId(Id configurationId, boolean match)	Adds a configuration Id for this query to match configurations which have as an ancestor the specified configuration.
void	matchAnyAncestorConfiguration(boolean match)	Matches configurations that have any ancestor.
void	matchAnyDescendantConfiguration(boolean match)	Matches configurations that have any descendant.
void	matchAnyParameter(boolean match)	Matches configurations that have any parameter.
void	matchDescendantConfigurationId(Id configurationId, boolean match)	Adds a configuration Id for this query to match configurations which have as a descendant the specified configuration.
void	matchParameterId(Id parameterId, boolean match)	Adds a parameter Id for this query.
void	matchRegistry(boolean match)	Matches configurations which are parameter registries.
boolean	supportsAncestorConfigurationQuery()	Tests if a ConfigurationQuery is available.
boolean	supportsDescendantConfigurationQuery()	Tests if a ConfigurationQuery is available.
boolean	supportsParameterQuery()	Tests if a ParameterQuery 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 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 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

matchRegistry

void matchRegistry(boolean match)

Matches configurations which are parameter registries.

Parameters:

match - true for a positive match, false otherwise

Compliance:

mandatory - This method must be implemented.

clearRegistryTerms

void clearRegistryTerms()

Clears the registry terms.

Compliance:

mandatory - This method must be implemented.

matchParameterId

void matchParameterId(Id parameterId,
 boolean match)

Adds a parameter Id for this query.

Parameters:

parameterId - a parameter Id

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

Throws:

NullArgumentException - parameterId is null

Compliance:

mandatory - This method must be implemented.

clearParameterIdTerms

void clearParameterIdTerms()

Clears the parameter Id terms.

Compliance:

mandatory - This method must be implemented.

supportsParameterQuery

boolean supportsParameterQuery()

Tests if a ParameterQuery is available.

Returns:

true if a parameter query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParameterQuery

ParameterQuery getParameterQuery()

Gets the query interface for a parameter.

Returns:

the parameter query

Throws:

UnimplementedException - supportsParameterQuery() is false

Compliance:

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

matchAnyParameter

void matchAnyParameter(boolean match)

Matches configurations that have any parameter.

Parameters:

match - true to match configurations with any parameter, false to match configurations with no parameter

Compliance:

mandatory - This method must be implemented.

clearParameterTerms

void clearParameterTerms()

Clears the parameter terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorConfigurationId

void matchAncestorConfigurationId(Id configurationId,
 boolean match)

Adds a configuration Id for this query to match configurations which have as an ancestor the specified configuration.

Parameters:

configurationId - a configuration Id

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

Throws:

NullArgumentException - configurationId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorConfigurationIdTerms

void clearAncestorConfigurationIdTerms()

Clears the ancestor configuration Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorConfigurationQuery

boolean supportsAncestorConfigurationQuery()

Tests if a ConfigurationQuery is available.

Returns:

true if a configuration query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorConfigurationQuery

ConfigurationQuery getAncestorConfigurationQuery()

Gets the query interface for a configuration.

Returns:

the configuration query

Throws:

UnimplementedException - supportsAncestorConfigurationQuery() is false

Compliance:

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

matchAnyAncestorConfiguration

void matchAnyAncestorConfiguration(boolean match)

Matches configurations that have any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorConfigurationTerms

void clearAncestorConfigurationTerms()

Clears the ancestor configuration terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantConfigurationId

void matchDescendantConfigurationId(Id configurationId,
 boolean match)

Adds a configuration Id for this query to match configurations which have as a descendant the specified configuration.

Parameters:

configurationId - a configuration Id

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

Throws:

NullArgumentException - configurationId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantConfigurationIdTerms

void clearDescendantConfigurationIdTerms()

Clears the descendant configuration Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantConfigurationQuery

boolean supportsDescendantConfigurationQuery()

Tests if a ConfigurationQuery is available.

Returns:

true if a configuration query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantConfigurationQuery

ConfigurationQuery getDescendantConfigurationQuery()

Gets the query interface for a configuration.

Returns:

the configuration query

Throws:

UnimplementedException - supportsDescendantConfigurationQuery() is false

Compliance:

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

matchAnyDescendantConfiguration

void matchAnyDescendantConfiguration(boolean match)

Matches configurations that have any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantConfigurationTerms

void clearDescendantConfigurationTerms()

Clears the descendant configuration terms.

Compliance:

mandatory - This method must be implemented.

getConfigurationQueryRecord

ConfigurationQueryRecord getConfigurationQueryRecord(Type configurationRecordType)
                                              throws OperationFailedException

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

Parameters:

configurationRecordType - a configuration record type

Returns:

the configuration query record

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationRecordType) is false

Compliance:

mandatory - This method must be implemented.