OSID - osid.filing.DirectoryQuery Service Interface Definition

Interface	osid.filing.DirectoryQuery
Implements	`osid.OsidCatalogQuery`
Implements	`osid.filing.DirectoryEntryQuery`
Used By	`osid.filing.DirectoryEntryQuery`
	`osid.filing.DirectoryQuerySession`
	`osid.filing.DirectorySearchSession`
Description	This is the query for searching directories. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR` . An example to find directories whose name is "Library". DirectoryQuery query = session.getDirectoryQuery(); query.matchName("Library", wordStringMatchType, true); DirectoryList list = session.getDirectoriesByQuery(query);
Method	matchFileName
Description	Matches directories that contain the specified file name.
Parameters	`string`	`name`	a file name
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`name` not of `stringMatchType`
	NULL_ARGUMENT		`name` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	clearFileNameTerms
Description	Clears all file name terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFileQuery
Description	Tests if a `FileQuery` is available.
Return	`boolean`		`true` if a file query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFileQuery
Description	Gets the query for a file contained within the directory.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Return	`osid.filing.FileQuery`		the directory query
Errors	UNIMPLEMENTED		`supportsFileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileQuery()` is `true` .
Method	matchAnyFile
Description	Matches directories with any file.
Parameters	`boolean`	`match`	`true` to match directories with any file,, `false` to match directories with no file.
Compliance	`mandatory`		This method must be implemented.
Method	clearFileTerms
Description	Clears all file terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDirectoryQueryRecord
Description	Gets the directory query record corresponding to the given `Directory` record `Type` . Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`directoryRecordType`	a directory record type
Return	`osid.filing.records.DirectoryQueryRecord`		the directory query 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.