Interface | osid.repository.AssetContentQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching asset contents. Each method
forms an | ||
Method | matchAccessibilityType | ||
Description |
Sets the accessibility types for this query. Supplying multiple types behaves like a boolean OR among the elements. | ||
Parameters | osid.type.Type | accessibilityType | an accessibilityType |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | accessibilityType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyAccessibilityType | ||
Description |
Matches asset content that has any accessibility type. | ||
Parameters | boolean | match | true to match content with any accessibility type,
false to match content with no accessibility type |
Compliance | mandatory | This method must be implemented. | |
Method | clearAccessibilityTypeTerms | ||
Description |
Clears the accessibility terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDataLength | ||
Description |
Matches content whose length of the data in bytes are inclusive of the given range. | ||
Parameters | cardinal | low | low range |
cardinal | high | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyDataLength | ||
Description |
Matches content that has any data length. | ||
Parameters | boolean | match | true to match content with any data length, false
to match content with no data length |
Compliance | mandatory | This method must be implemented. | |
Method | clearDataLengthTerms | ||
Description |
Clears the data length terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchData | ||
Description |
Matches data in this content. | ||
Parameters | byte[] | data | list of matching strings |
boolean | match | true for a positive match, false for a
negative match | |
boolean | partial | true for a partial match, false for a
complete match | |
Errors | NULL_ARGUMENT | data is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyData | ||
Description |
Matches content that has any data. | ||
Parameters | boolean | match | true to match content with any data, false to
match content with no data |
Compliance | mandatory | This method must be implemented. | |
Method | clearDataTerms | ||
Description |
Clears the data terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchURL | ||
Description |
Sets the url for this query. Supplying multiple strings
behaves like a boolean | ||
Parameters | string | url | url string 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 | url not of stringMatchType | |
NULL_ARGUMENT | url or stringMatchType is null | ||
UNSUPPORTED | supportsStringMatchType(url) is false | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyURL | ||
Description |
Matches content that has any url. | ||
Parameters | boolean | match | true to match content with any url, false to
match content with no url |
Compliance | mandatory | This method must be implemented. | |
Method | clearURLTerms | ||
Description |
Clears the url terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssetContentQueryRecord | ||
Description |
Gets the asset content query record corresponding to
the given | ||
Parameters | osid.type.Type | assetContentRecordType | an asset content record type |
Return | osid.repository.records.AssetContentQueryRecord | the asset content query record | |
Errors | NULL_ARGUMENT | assetContentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(assetContentRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |