OSID - osid.filing.FileSmartDirectorySession Service Interface Definition

Interface	osid.filing.FileSmartDirectorySession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `FileQuery` can be retrieved from this session and mapped to this `Directory` to create a virtual collection of files. The files may be sequenced using the `FileSearchOrder` from this session. This `Directory` has a default query that matches any file and a default search order that specifies no sequencing. The queries may be examined using a `FileQueryInspector.` The query may be modified by converting the inspector back to a `FileQuery.`
Method	getDirectoryId
Description	Gets the absolute path 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	canManageSmartDirectories
Description	Tests if this user can manage smart directories. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart directory management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFileQuery
Description	Gets a file query.
Return	`osid.filing.FileQuery`		the file query
Compliance	`mandatory`		This method must be implemented.
Method	getFileSearchOrder
Description	Gets a file search order. The `FileSearchOrder` is supplied to a `FileSearch` to specify the ordering of results.
Return	`osid.filing.FileSearchOrder`		the file search order
Compliance	`mandatory`		This method must be implemented.
Method	applyFileQuery
Description	Applies a file query to this directory.
Parameters	`osid.filing.FileQuery`	`fileQuery`	the file query
Errors	NULL_ARGUMENT		`fileQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`fileQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectFileQuery
Description	Gets a file query inspector for this directory.
Return	`osid.filing.FileQueryInspector`		the file query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyFileSequencing
Description	Applies a file search order to this directory.
Parameters	`osid.filing.FileSearchOrder`	`fileSearchOrder`	the file search order
Errors	NULL_ARGUMENT		`fileSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`fileSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFileQueryFromInspector
Description	Gets a file query from an inspector.
Parameters	`osid.filing.FileQueryInspector`	`fileQueryInspector`	a file query inspector
Return	`osid.filing.FileQuery`		the file query
Errors	NULL_ARGUMENT		`fileQueryInspector` is `null`
Errors	UNSUPPORTED		`fileQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.