Interface | osid.filing.FileQuery | ||
---|---|---|---|
Implements | osid.filing.DirectoryEntryQuery | ||
Description |
This is the query for searching files. Each method
specifies an | ||
Method | matchSize | ||
Description |
Matches files whose size is within and including the given range. | ||
Parameters | cardinal | from | low file size |
cardinal | to | high file size | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | to is les than from | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySize | ||
Description |
Matches a file that has any known size. | ||
Parameters | boolean | match | true to match any size, false to match files
with no known size |
Compliance | mandatory | This method must be implemented. | |
Method | clearSizeTerms | ||
Description |
Clears all file size terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDataString | ||
Description |
Adds data strings to this query to match files whose
content contains these strings. Supplying multiple strings
behaves like a boolean AND among the elements each which
must correspond to the | ||
Parameters | string | data | 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 | data not of stringMatchType | |
NULL_ARGUMENT | data or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDataStringTerms | ||
Description |
Clears all file data string terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchData | ||
Description |
Matches files who data contains the given bytes. | ||
Parameters | byte[] | data | data to match |
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 a file that has any data. | ||
Parameters | boolean | match | true to match any data, false to match files
with no data |
Compliance | mandatory | This method must be implemented. | |
Method | clearDataTerms | ||
Description |
Clears all file data terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFileQueryRecord | ||
Description |
Gets the file query record corresponding to the given
| ||
Parameters | osid.type.Type | fileRecordType | a file record type |
Return | osid.filing.records.FileQueryRecord | the file query record | |
Errors | NULL_ARGUMENT | fileRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(fileRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |