OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.FileQuery
Implementsosid.filing.DirectoryEntryQuery
Description

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

MethodmatchSize
Description

Matches files whose size is within and including the given range.

Parameterscardinalfromlow file size
cardinaltohigh file size
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to is les than from
CompliancemandatoryThis method must be implemented.
MethodmatchAnySize
Description

Matches a file that has any known size.

Parametersbooleanmatch true to match any size, false to match files with no known size
CompliancemandatoryThis method must be implemented.
MethodclearSizeTerms
Description

Clears all file size terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDataString
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 stringMatchType. An OR can be performed with multiple queries.

Parametersstringdatastring to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT data not of stringMatchType
NULL_ARGUMENT data or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodclearDataStringTerms
Description

Clears all file data string terms.

CompliancemandatoryThis method must be implemented.
MethodmatchData
Description

Matches files who data contains the given bytes.

Parametersbyte[]datadata to match
booleanmatch true for a positive match, false for a negative match
booleanpartial true for a partial match, false for a complete match
ErrorsNULL_ARGUMENT data is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyData
Description

Matches a file that has any data.

Parametersbooleanmatch true to match any data, false to match files with no data
CompliancemandatoryThis method must be implemented.
MethodclearDataTerms
Description

Clears all file data terms.

CompliancemandatoryThis method must be implemented.
MethodgetFileQueryRecord
Description

Gets the file query record corresponding to the given File record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypefileRecordTypea file record type
Returnosid.filing.records.FileQueryRecordthe file query record
ErrorsNULL_ARGUMENT fileRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fileRecordType) is false
CompliancemandatoryThis method must be implemented.