OSID - osid.filing.FilingProxyManager Service Interface Definition

Interface	osid.filing.FilingProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.filing.FilingProfile`
Description	The filing manager provides access sessions to retrieve and manage files and directories. A manager may support federation in that files and directories can be accessed by a specified path. Methods in this manager support the passing of a `Proxy` to pass information from server environments. The sessions included in this manager are: `FileSystemSession:` a session for traversing file systems `FileSystemManagementSession:` a session for performing operations across directories `FileContentSession:` a basic session for reading and writing a file FileLookupSession: a session for looking up files `FileQuerySession:` a session for searching for files `FileSearchSession:` a session for searching for files `FileNotificationSession:` a session for subscribing to changes in files `FileSmartDirectorySession:` a session for managing smart directories of files `DirectoryLookupSession:` a session for looking up a directories `DirectorQuerySession:` a session for searching for directories `DirectorySearchSession:` a session for searching for directories `DirectoryNotificationSession:` a session for subscribing to changes in directories
Method	getFileSystemSession
Description	Gets the session for examining file systems.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemSession`		a `FileSystemSession`
Errors	NULL_ARGUMENT		`proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystem()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystem()` is `true.`
Method	getFileSystemSessionForPath
Description	Gets the session for exmaning file systems for the given path.
Parameters	`string`	`path`	the path to a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemSession`		a `FileSystemSession`
Errors	NOT_FOUND		`path` is not found or is not a directory
	NULL_ARGUMENT		`path` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystem()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystem()` and `supportsVisibleFederation()` are `true.`
Method	getFileSystemSessionForDirectory
Description	Gets the session for exmaning file systems for the given directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` of a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemSession`		a `FileSystemSession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystem()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystem()` and `supportsVisibleFederation()` are `true.`
Method	getFileSystemManagementSession
Description	Gets the session for manipulating file systems.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemManagementSession`		a `FileSystemManagementSession`
Errors	NULL_ARGUMENT		`proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystemManagement()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystemManagement()` is `true.`
Method	getFileSystemManagementSessionForPath
Description	Gets the session for manipulating files for the given path.
Parameters	`string`	`path`	the path to a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemManagementSession`		a `FileSystemManagementSession`
Errors	NOT_FOUND		`path` is not found or is not a directory
	NULL_ARGUMENT		`path` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystemManagement()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystemManagement()` and `supportsVisibleFederation()` are `true.`
Method	getFileSystemManagementSessionForDirectory
Description	Gets the session for manipulating files for the given path.
Parameters	`osid.id.Id`	`directoryId`	the `Id` of a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSystemManagementSession`		a `FileSystemManagementSession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSystemManagement()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSystemManagement()` and `supportsVisibleFederation()` are `true.`
Method	getFileContentSession
Description	Gets the session for reading and writing files.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileContentSession`		a `FileContentSession`
Errors	NULL_ARGUMENT		`proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileContent()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileContent()` is `true.`
Method	getFileContentSessionForPath
Description	Gets the session for reading and writing files for the given path.
Parameters	`string`	`path`	the path to a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileContentSession`		a `FileContentSession`
Errors	NOT_FOUND		`path` is not found or is not a directory
	NULL_ARGUMENT		`path` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileContent()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileContent()` and `supportsVisibleFederation()` are `true.`
Method	getFileContentSessionForDirectory
Description	Gets the session for reading and writing files for the given path.
Parameters	`osid.id.Id`	`directoryId`	the `Id` of a directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileContentSession`		a `FileContentSession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileContent()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileContent()` and `supportsVisibleFederation()` are `true.`
Method	getFileLookupSession
Description	Gets the session for looking up files.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileLookupSession`		the `FileLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileLookup()` is `true.`
Method	getFileLookupSessionForDirectory
Description	Gets a file lookup session for the specified directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileLookupSession`		a `FileLookupSession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileLookup()` and `supportsVisibleFederation()` are `true.`
Method	getFileQuerySession
Description	Gets the session for querying files.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileQuerySession`		the `FileQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileQuery()` is `true.`
Method	getFileQuerySessionForDirectory
Description	Gets a file query session for the specified directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileQuerySession`		a `FileQuerySession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileQuery()` and `supportsVisibleFederation()` are `true.`
Method	getFileSearchSession
Description	Gets the session for searching for files.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSearchSession`		the `FileSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSearch()` is `true.`
Method	getFileSearchSessionForDirectory
Description	Gets a file search session for the specified directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSearchSession`		a `FileSearchSession`
Errors	NOT_FOUND		`directoryId` is not found
	NULL_ARGUMENT		`directoryId` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSearch()` and `supportsVisibleFederation()` are `true.`
Method	getFileNotificationSession
Description	Gets the session for receiving messages about changes to files.
Parameters	`osid.filing.FileReceiver`	`fileReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileNotificationSession`		`a FileNotificationSession`
Errors	NULL_ARGUMENT		`fileReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileNotification()` is `true.`
Method	getFileNotificationSessionForDirectory
Description	Gets a file notification session for the specified directory.
Parameters	`osid.filing.FileReceiver`	`fileReceiver`	the notification callback
	`osid.id.Id`	`directoryId`	the `Id` to the directory
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileNotificationSession`		a `FileNotificationSession`
Errors	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`fileReceiver, directoryId,` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileNotification()` and `supportsVisibleFederation()` are `true.`
Method	getFileSmartDirectorySession
Description	Gets the session for managing dynamic diectories.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.FileSmartDirectorySession`		a `FileSmartDirectorySession`
Errors	NOT_FOUND		`directoryId is not found`
	NULL_ARGUMENT		`directoryId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsFileSmartDirectory()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFileSmartDirectory()` and `supportsVisibleFederation()` are `true.`
Method	getDirectoryLookupSession
Description	Gets the session for examining directories.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryLookupSession`		a `DirectoryLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryLookup()` is `true.`
Method	getDirectoryLookupSessionForDirectory
Description	Gets the session for examining a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryLookupSession`		a `DirectoryLookupSession`
Errors	NOT_FOUND		`directoryId is not found`
	NULL_ARGUMENT		`directoryId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryLookup()` and `supportsVisibleFederation()` are `true.`
Method	getDirectoryQuerySession
Description	Gets the session for querying directories.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryQuerySession`		a `DirectoryQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryQuery()` is `true.`
Method	getDirectoryQuerySessionForDirectory
Description	Gets the session for querying directories within a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryQuerySession`		a `DirectoryQuerySession`
Errors	NOT_FOUND		`directoryId is not found`
	NULL_ARGUMENT		`directoryId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryQuery()` and `supportsVisibleFederation()` are `true.`
Method	getDirectorySearchSession
Description	Gets the session for searching for directories.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectorySearchSession`		a `DirectorySearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectorySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectorySearch()` is `true.`
Method	getDirectorySearchSessionForDirectory
Description	Gets the session for searching for directories within a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectorySearchSession`		a `DirectorySearchSession`
Errors	NOT_FOUND		`directoryId is not found`
	NULL_ARGUMENT		`directoryId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectorySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectorySearch()` and `supportsVisibleFederation()` are `true.`
Method	getDirectoryAdminSession
Description	Gets the session for creating and removing files.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryAdminSession`		a `DirectoryAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryAdmin()` is `true.`
Method	getDirectoryAdminSessionForDirectory
Description	Gets the session for searching for creating and removing files in the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.id.Id`	`directoryId`	the `Id` to the directory
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryAdminSession`		a `DirectoryAdminSession`
Errors	NOT_FOUND		`directoryId is not found`
	NULL_ARGUMENT		`directoryId or proxy is null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getDirectoryNotificationSession
Description	Gets the session for receiving messages about changes to directories.
Parameters	`osid.filing.DirectoryReceiver`	`directoryReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryNotificationSession`		a `DirectoryNotificationSession`
Errors	NULL_ARGUMENT		`directoryReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryNotification()` is `true.`
Method	getDirectoryNotificationSessionForDirectory
Description	Gets the session for receiving messages about changes to directories in the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.filing.DirectoryReceiver`	`directoryReceiver`	the notification callback
	`osid.id.Id`	`directoryId`	the `Id` to the directory
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.filing.DirectoryNotificationSession`		a `DirectoryNotificationSession`
Errors	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`directoryReceiver, directoryId,` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDirectoryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryNotification()` and `supportsVisibleFederation()` are `true.`
Method	getFilingAllocationProxyManager
Description	Gets the `FilingAllocationProxyManager.`
Return	`osid.filing.allocation.FilingAllocationProxyManager`		a `FilingAllocationProxyManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFilingAllocation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFilingAllocation()` is `true.`