org.osid.configuration.rules

Interface ParameterProcessorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface ParameterProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining parameter processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getConfigurationIdTerms() Gets the configuration Id query terms.
ConfigurationQueryInspector[]	getConfigurationTerms() Gets the configuration query terms.
ParameterProcessorQueryInspectorRecord	getParameterProcessorQueryInspectorRecord(Type parameterProcessorRecordType) Gets the parameter processor query inspector record corresponding to the given ParameterProcessor record Type.
IdTerm[]	getRuledParameterIdTerms() Gets the parameter Id query terms.
ParameterQueryInspector[]	getRuledParameterTerms() Gets the parameter query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getRuledParameterIdTerms

IdTerm[] getRuledParameterIdTerms()

Gets the parameter Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledParameterTerms

ParameterQueryInspector[] getRuledParameterTerms()

Gets the parameter query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConfigurationIdTerms

IdTerm[] getConfigurationIdTerms()

Gets the configuration Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConfigurationTerms

ConfigurationQueryInspector[] getConfigurationTerms()

Gets the configuration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getParameterProcessorQueryInspectorRecord

ParameterProcessorQueryInspectorRecord getParameterProcessorQueryInspectorRecord(Type parameterProcessorRecordType)
                                                                                 throws OperationFailedException

Gets the parameter processor query inspector record corresponding to the given ParameterProcessor record Type.

Parameters:

parameterProcessorRecordType - a parameter processor record type

Returns:

the parameter processor query inspector record

Throws:

NullArgumentException - parameterProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.