org.osid.configuration

Interface ConfigurationQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface ConfigurationQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining configuration queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorConfigurationIdTerms() Gets the ancestor configuration Id query terms.
ConfigurationQueryInspector[]	getAncestorConfigurationTerms() Gets the ancestor configuration query terms.
ConfigurationQueryInspectorRecord	getConfigurationQueryInspectorRecord(Type configurationRecordType) Gets the configuration query inspector record corresponding to the given Configuration record Type.
IdTerm[]	getDescendantConfigurationIdTerms() Gets the descendant configuration Id query terms.
ConfigurationQueryInspector[]	getDescendantConfigurationTerms() Gets the descendant configuration query terms.
IdTerm[]	getParameterIdTerms() Gets the parameter Id query terms.
ParameterQueryInspector[]	getParameterTerms() Gets the parameter query terms.
BooleanTerm[]	getRegistryTerms() Gets the registry query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getRegistryTerms

BooleanTerm[] getRegistryTerms()

Gets the registry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getParameterIdTerms

IdTerm[] getParameterIdTerms()

Gets the parameter Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getParameterTerms

ParameterQueryInspector[] getParameterTerms()

Gets the parameter query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorConfigurationIdTerms

IdTerm[] getAncestorConfigurationIdTerms()

Gets the ancestor configuration Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorConfigurationTerms

ConfigurationQueryInspector[] getAncestorConfigurationTerms()

Gets the ancestor configuration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantConfigurationIdTerms

IdTerm[] getDescendantConfigurationIdTerms()

Gets the descendant configuration Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantConfigurationTerms

ConfigurationQueryInspector[] getDescendantConfigurationTerms()

Gets the descendant configuration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConfigurationQueryInspectorRecord

ConfigurationQueryInspectorRecord getConfigurationQueryInspectorRecord(Type configurationRecordType)
                                                                       throws OperationFailedException

Gets the configuration query inspector record corresponding to the given Configuration record Type.

Parameters:

configurationRecordType - a configuration record type

Returns:

the configuration query inspector record

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationRecordType) is false

Compliance:

mandatory - This method must be implemented.