Interface SettingQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector
public interface SettingQueryInspector extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining setting queries.

  • Method Details

    • getControllerIdTerms

      IdTerm[] getControllerIdTerms()
      Gets the controller Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getControllerTerms

      ControllerQueryInspector[] getControllerTerms()
      Gets the controller query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getOnTerms

      BooleanTerm[] getOnTerms()
      Gets the on query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getOffTerms

      BooleanTerm[] getOffTerms()
      Gets the off query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getVariablePercentageTerms

      DecimalRangeTerm[] getVariablePercentageTerms()
      Gets the variable percentage query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getVariableAmountTerms

      DecimalRangeTerm[] getVariableAmountTerms()
      Gets the variable amount query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDiscreetStateIdTerms

      IdTerm[] getDiscreetStateIdTerms()
      Gets the discreet state Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDiscreetStateTerms

      StateQueryInspector[] getDiscreetStateTerms()
      Gets the discreet state query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getRampRateTerms

      DurationRangeTerm[] getRampRateTerms()
      Gets the ramp rate query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSystemIdTerms

      IdTerm[] getSystemIdTerms()
      Gets the system Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSystemTerms

      SystemQueryInspector[] getSystemTerms()
      Gets the system query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSettingQueryInspectorRecord

      SettingQueryInspectorRecord getSettingQueryInspectorRecord(Type settingRecordType) throws OperationFailedException
      Gets the setting query inspector record corresponding to the given Setting record Type .
      Parameters:
      settingRecordType - a setting record type
      Returns:
      the setting query inspector record
      Throws:
      NullArgumentException - settingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(settingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.