org.osid.configuration

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

Methods

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

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

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 supportsParameterQuery() is 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 supportsAncestorConfigurationQuery() is 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 supportsDescendantConfigurationQuery() is 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.