Interface | osid.OsidQuery | ||
---|---|---|---|
Implements | osid.Suppliable | ||
Description |
The If multiple data elements are set in this interface, the results matching all the given data (eg: AND) are returned. Any match method inside an OsidQuery { OsidQuery.matchDisplayName AND (OsidQuery.matchDescription OR OsidQuery.matchDescription)} An | ||
Method | getStringMatchTypes | ||
Description |
Gets the string matching types supported. A string match type specifies the syntax of the string query, such as matching a word or including a wildcard or regular expression. | ||
Return | osid.type.TypeList | a list containing the supported string match types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsStringMatchType | ||
Description |
Tests if the given string matching type is supported. | ||
Parameters | osid.type.Type | stringMatchType | a Type indicating a string match type |
Return | boolean | true if the given Type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | stringMatchType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchKeyword | ||
Description |
Adds a keyword to match. Multiple keywords can be added
to perform a boolean | ||
Parameters | string | keyword | keyword to match |
osid.type.Type | stringMatchType | the string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | keyword is not of stringMatchType | |
NULL_ARGUMENT | keyword or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | clearKeywordTerms | ||
Description |
Clears all keyword terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAny | ||
Description |
Matches any object. | ||
Parameters | boolean | match | true to match any object , false
to match no objects |
Compliance | mandatory | This method must be implemented. | |
Method | clearAnyTerms | ||
Description |
Clears the match any terms. | ||
Compliance | mandatory | This method must be implemented. |