OSID - osid.filing.DirectoryQuerySession Service Interface Definition

Interface	osid.filing.DirectoryQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Directory` objects. The search query is constructed using the `DirectoryQuery.` This session defines views that offer differing behaviors for searching. federated directory view: searches include directories in directories of which this directory is an ancestor isolated directory view: searches are restricted to diectories in this directory only
Method	getDirectoryId
Description	Gets the `Id` of this directory.
Return	`osid.id.Id`		the `Id` of this directory
Compliance	`mandatory`		This method must be implemented.
Method	getDirectory
Description	Gets the directory associated with this session.
Return	`osid.filing.Directory`		the directory associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchDirectories
Description	Tests if this user can perform `Directory` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedDirectoryView
Description	Federates the view for methods in this session. A federated view will include entries in directories which are children of this directory.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDirectoryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this directory only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDirectoryQuery
Description	Gets a directory query.
Return	`osid.filing.DirectoryQuery`		the directory query
Compliance	`mandatory`		This method must be implemented.
Method	getDirectoriesByQuery
Description	Gets a list of `Directory` objects matching the given directory query.
Parameters	`osid.filing.DirectoryQuery`	`directoryQuery`	the directory query
Return	`osid.filing.DirectoryList`		the returned `DirectoryList`
Errors	NULL_ARGUMENT		`directoryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`directoryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.