OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControllerQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
Description

This is the query for searching controllers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchAddress
Description

Mathes an address.

Parametersstringaddressan address
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT address or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodclearAddressTerms
Description

Clears the address query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchModelId
Description

Sets the model Id for this query.

Parametersosid.id.IdmodelIdthe model Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT modelId is null
CompliancemandatoryThis method must be implemented.
MethodclearModelIdTerms
Description

Clears the model Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsModelQuery
Description

Tests if a ModelQuery is available.

Returnboolean true if a model query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetModelQuery
Description

Gets the query for a Model. Multiple retrievals produce a nested OR term.

Returnosid.inventory.ModelQuerythe model query
ErrorsUNIMPLEMENTED supportsModelQuery() is false
ComplianceoptionalThis method must be implemented if supportsModelQuery() is true.
MethodmatchAnyModel
Description

Matches any models.

Parametersbooleanmatch true to match controllers with models, false to match controllers with no model defined
CompliancemandatoryThis method must be implemented.
MethodclearModelTerms
Description

Clears the model query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVersion
Description

Sets the version for this query.

Parametersosid.installation.Versionversionthe version
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT version is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyVersion
Description

Matches controllers with any version.

Parametersbooleanmatch true to match controllers with versions, false to match controllers with no version defined
CompliancemandatoryThis method must be implemented.
MethodclearVersionTerms
Description

Clears the version query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVersionSince
Description

Matches controllers with versions including and more recent than the given version.

Parametersosid.installation.Versionversionthe version
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT version is null
CompliancemandatoryThis method must be implemented.
MethodclearVersionSinceTerms
Description

Clears the version since query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchToggleable
Description

Matches toggleable controllers.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearToggleableTerms
Description

Clears the toggleable query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVariable
Description

Matches variable controllers.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearVariableTerms
Description

Clears the variable query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVariableByPercentage
Description

Matches variable by percentage controllers.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearVariableByPercentageTerms
Description

Clears the variable query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVariableMinimum
Description

Matches variable minimums between the given range inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyVariableMinimum
Description

Matches any variable minimums.

Parametersbooleanmatch true to match controllers with variable minimums, false to match controllers with no variable minimums
CompliancemandatoryThis method must be implemented.
MethodclearVariableMinimumTerms
Description

Clears the variable minimum query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVariableMaximum
Description

Matches variable maximums between the given range inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyVariableMaximum
Description

Matches any variable maximums.

Parametersbooleanmatch true to match controllers with variable maximums, false to match controllers with no variable maximums
CompliancemandatoryThis method must be implemented.
MethodclearVariableMaximumTerms
Description

Clears the variable maximum query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDiscreetStates
Description

Matches discreet states controllers.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetStatesTerms
Description

Clears the discreet states query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDiscreetStateId
Description

Sets the state Id for this query.

Parametersosid.id.IdstateIdthe state Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetStateIdTerms
Description

Clears the state Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDiscreetStateQuery
Description

Tests if a StateQuery is available.

Returnboolean true if a state query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetStateQuery
Description

Gets the query for a State. Multiple retrievals produce a nested OR term.

Returnosid.process.StateQuerythe state query
ErrorsUNIMPLEMENTED supportsDiscreetStateQuery() is false
ComplianceoptionalThis method must be implemented if supportsDiscreetStateQuery() is true.
MethodmatchAnyDiscreetState
Description

Matches any discreet states.

Parametersbooleanmatch true to match controllers with discreet states, false to match controllers with no discreet states
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetStateTerms
Description

Clears the state query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSystemId
Description

Sets the system Id for this query.

Parametersosid.id.IdsystemIdthe system Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodclearSystemIdTerms
Description

Clears the system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSystemQuery
Description

Tests if a SystemQuery is available.

Returnboolean true if a system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSystemQuery
Description

Gets the query for a system. Multiple retrievals produce a nested OR term.

Returnosid.control.SystemQuerythe system query
ErrorsUNIMPLEMENTED supportsSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsSystemQuery() is true.
MethodclearSystemTerms
Description

Clears the system query terms.

CompliancemandatoryThis method must be implemented.
MethodgetControllerQueryRecord
Description

Gets the controller query record corresponding to the given Controller record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecontrollerRecordTypea controller record type
Returnosid.control.records.ControllerQueryRecordthe controller query record
ErrorsNULL_ARGUMENT controllerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(controllerRecordType) is false
CompliancemandatoryThis method must be implemented.