Interface | osid.filing.DirectoryQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
osid.filing.DirectoryEntryQueryInspector | |||
Description |
This is the query inspector for examining directory queries. | ||
Method | getFileNameTerms | ||
Description |
Gets the file name query terms. | ||
Return | osid.search.terms.StringTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileTerms | ||
Description |
Gets the file query terms. | ||
Return | osid.filing.FileQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoryQueryInspectorRecord | ||
Description |
Gets the directory query inspector record corresponding
to the given | ||
Parameters | osid.type.Type | directoryRecordType | a directory record type |
Return | osid.filing.records.DirectoryQueryInspectorRecord | the directory query inspector record | |
Errors | NULL_ARGUMENT | directoryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(directoryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |