OSID Logo
OSID Specifications
filing package
Version 3.1.0
Interfaceosid.filing.DirectoryQueryInspector
Implementsosid.OsidCatalogQueryInspector
osid.filing.DirectoryEntryQueryInspector
Used Byosid.filing.DirectoryEntryQueryInspector
osid.filing.DirectorySearchResults
Description

This is the query inspector for examining directory queries.

Like all OsidQueryInspectors, DirectoryQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetFileNameTerms
Description

Gets the file name query terms.

Returnosid.search.terms.StringTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetFileTerms
Description

Gets the file query terms.

Returnosid.filing.FileQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetDirectoryQueryInspectorRecord
Description

Gets the directory query inspector record corresponding to the given Directory record Type.

Parametersosid.type.TypedirectoryRecordType a directory record type
Returnosid.filing.records.DirectoryQueryInspectorRecord the directory query inspector record
ErrorsNULL_ARGUMENT directoryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(directoryRecordType) is false
Compliancemandatory This method must be implemented.