Interface | osid.control.ControllerQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidOperableQuery | |||
Description |
This is the query for searching controllers. Each method
match specifies an | ||
Method | matchAddress | ||
Description |
Mathes an address. | ||
Parameters | string | address | an address |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | address or stringMatchType is null
| |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressTerms | ||
Description |
Clears the address query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchModelId | ||
Description |
Sets the model | ||
Parameters | osid.id.Id | modelId | the model Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | modelId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearModelIdTerms | ||
Description |
Clears the model | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsModelQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a model query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelQuery | ||
Description |
Gets the query for a | ||
Return | osid.inventory.ModelQuery | the model query | |
Errors | UNIMPLEMENTED | supportsModelQuery() is false | |
Compliance | optional | This method must be implemented if supportsModelQuery() is
true. | |
Method | matchAnyModel | ||
Description |
Matches any models. | ||
Parameters | boolean | match | true to match controllers with models, false
to match controllers with no model defined |
Compliance | mandatory | This method must be implemented. | |
Method | clearModelTerms | ||
Description |
Clears the model query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVersion | ||
Description |
Sets the version for this query. | ||
Parameters | osid.installation.Version | version | the version |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | version is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyVersion | ||
Description |
Matches controllers with any version. | ||
Parameters | boolean | match | true to match controllers with versions, false
to match controllers with no version defined |
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionTerms | ||
Description |
Clears the version query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVersionSince | ||
Description |
Matches controllers with versions including and more recent than the given version. | ||
Parameters | osid.installation.Version | version | the version |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | version is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVersionSinceTerms | ||
Description |
Clears the version since query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchToggleable | ||
Description |
Matches toggleable controllers. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearToggleableTerms | ||
Description |
Clears the toggleable query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVariable | ||
Description |
Matches variable controllers. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearVariableTerms | ||
Description |
Clears the variable query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVariableByPercentage | ||
Description |
Matches variable by percentage controllers. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearVariableByPercentageTerms | ||
Description |
Clears the variable query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVariableMinimum | ||
Description |
Matches variable minimums between the given range inclusive. | ||
Parameters | decimal | start | start of range |
decimal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyVariableMinimum | ||
Description |
Matches any variable minimums. | ||
Parameters | boolean | match | true to match controllers with variable minimums,
false to match controllers with no variable minimums |
Compliance | mandatory | This method must be implemented. | |
Method | clearVariableMinimumTerms | ||
Description |
Clears the variable minimum query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVariableMaximum | ||
Description |
Matches variable maximums between the given range inclusive. | ||
Parameters | decimal | start | start of range |
decimal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyVariableMaximum | ||
Description |
Matches any variable maximums. | ||
Parameters | boolean | match | true to match controllers with variable maximums,
false to match controllers with no variable maximums |
Compliance | mandatory | This method must be implemented. | |
Method | clearVariableMaximumTerms | ||
Description |
Clears the variable maximum query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDiscreetStates | ||
Description |
Matches discreet states controllers. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearDiscreetStatesTerms | ||
Description |
Clears the discreet states query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDiscreetStateId | ||
Description |
Sets the state | ||
Parameters | osid.id.Id | stateId | the state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDiscreetStateIdTerms | ||
Description |
Clears the state | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDiscreetStateQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a state query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDiscreetStateQuery | ||
Description |
Gets the query for a | ||
Return | osid.process.StateQuery | the state query | |
Errors | UNIMPLEMENTED | supportsDiscreetStateQuery() is false | |
Compliance | optional | This method must be implemented if supportsDiscreetStateQuery()
is true. | |
Method | matchAnyDiscreetState | ||
Description |
Matches any discreet states. | ||
Parameters | boolean | match | true to match controllers with discreet states, false
to match controllers with no discreet states |
Compliance | mandatory | This method must be implemented. | |
Method | clearDiscreetStateTerms | ||
Description |
Clears the state query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSystemId | ||
Description |
Sets the system | ||
Parameters | osid.id.Id | systemId | the system Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | systemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSystemIdTerms | ||
Description |
Clears the system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemQuery | ||
Description |
Gets the query for a system. Multiple retrievals
produce a nested | ||
Return | osid.control.SystemQuery | the system query | |
Errors | UNIMPLEMENTED | supportsSystemQuery() is false | |
Compliance | optional | This method must be implemented if supportsSystemQuery() is
true. | |
Method | clearSystemTerms | ||
Description |
Clears the system query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllerQueryRecord | ||
Description |
Gets the controller query record corresponding to the
given | ||
Parameters | osid.type.Type | controllerRecordType | a controller record type |
Return | osid.control.records.ControllerQueryRecord | the controller query record | |
Errors | NULL_ARGUMENT | controllerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(controllerRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |