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.
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. |
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
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchRegistry(boolean match)
match
- true
for a positive match, false
otherwisemandatory
- This method must be implemented. void clearRegistryTerms()
mandatory
- This method must be implemented. void matchParameterId(Id parameterId, boolean match)
Id
for this query.parameterId
- a parameter Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- parameterId
is
null
mandatory
- This method must be implemented. void clearParameterIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsParameterQuery()
ParameterQuery
is available. true
if a parameter query interface is
available, false
otherwisemandatory
- This method must be implemented. ParameterQuery getParameterQuery()
UnimplementedException
-
supportsParameterQuery()
is false
optional
- This method must be implemented if
supportsParameterQuery()
is true.
void matchAnyParameter(boolean match)
match
- true
to match configurations with any
parameter, false
to match configurations with
no parametermandatory
- This method must be implemented. void clearParameterTerms()
mandatory
- This method must be implemented. void matchAncestorConfigurationId(Id configurationId, boolean match)
Id
for this query to match
configurations which have as an ancestor the specified configuration.configurationId
- a configuration Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. void clearAncestorConfigurationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorConfigurationQuery()
ConfigurationQuery
is available. true
if a configuration query interface is
available, false
otherwisemandatory
- This method must be implemented. ConfigurationQuery getAncestorConfigurationQuery()
UnimplementedException
-
supportsAncestorConfigurationQuery()
is false
optional
- This method must be implemented if
supportsAncestorConfigurationQuery()
is
true.
void matchAnyAncestorConfiguration(boolean match)
match
- true
to match configurations with any
ancestor, false
to match root configurationsmandatory
- This method must be implemented. void clearAncestorConfigurationTerms()
mandatory
- This method must be implemented. void matchDescendantConfigurationId(Id configurationId, boolean match)
Id
for this query to match
configurations which have as a descendant the specified configuration.configurationId
- a configuration Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. void clearDescendantConfigurationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantConfigurationQuery()
ConfigurationQuery
is available. true
if a configuration query interface is
available, false
otherwisemandatory
- This method must be implemented. ConfigurationQuery getDescendantConfigurationQuery()
UnimplementedException
-
supportsDescendantConfigurationQuery()
is false
optional
- This method must be implemented if
supportsDescendantConfigurationQuery()
is
true.
void matchAnyDescendantConfiguration(boolean match)
match
- true
to match configurations with any
descendant, false
to match leaf configurationsmandatory
- This method must be implemented. void clearDescendantConfigurationTerms()
mandatory
- This method must be implemented. ConfigurationQueryRecord getConfigurationQueryRecord(Type configurationRecordType) throws OperationFailedException
Configuration
record Type.
Multiple record
retrievals produce a nested OR
term.configurationRecordType
- a configuration record typeNullArgumentException
- configurationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(configurationRecordType)
is false
mandatory
- This method must be implemented.