OSID - osid.filing.FileSystemManagementSession Service Interface Definition

Interface	osid.filing.FileSystemManagementSession
Implements	`osid.OsidSession`
Used By	`osid.filing.FilingManager`
Used By	`osid.filing.FilingProxyManager`
Description	This session defines methods for operating on files and directories. This session is an expanded version of the `DirectoryAdminSession` that defines methods requiring path names for navigating a federation of directories as opposed to working within a single directory node. The directory associated with this session is the current working directory and any relative path names provided are with respect to this directory. Absolute pathnames may be supplied outside this directory.
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	canManageFiling
Description	Tests if this user can perform functions in this session. 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if filing management methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	overwrite
Description	Overwrite files if a destination pathname exists.
Parameters	`boolean`	`overwite`	`true` if files can be overwritten, `false` otherwise
Compliance	`mandatory`		This method is must be implemented.
Method	createMissingPaths
Description	Create any missing directories for a destination path that does not exist.
Parameters	`boolean`	`create`	`true` if intermediate directories should be created, `false` otherwise
Compliance	`mandatory`		This method is must be implemented.
Method	moveFile
Description	Moves a file to another path. The detination path may be a file or directory. If the destination is a file and exists, the destination is only replaced if `overwrite()` is `true`. If the destination is a directory and does not exist, the missing directories are only created if `createMissingPaths()` is `true`.
Parameters	`osid.id.Id`	`src`	the source `Id` of the file
Parameters	`string`	`dst`	the destination name or path of the directory or file
Errors	ALREADY_EXISTS		`dst` exists and `overwrite()` is `false`
	INVALID_ARGUMENT		`src` is not a file
	NOT_FOUND		`src` is not found, or the path to `dst` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`src` or `dst` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDirectory
Description	Moves a directory to another path. The destination must be a directory and if exists, the source directory is placed as a child to the given directory. If a path component in the destination does not exist, the path is created is `createMissingPaths()` is `true`.
Parameters	`osid.id.Id`	`src`	the source `Id` of the directory
Parameters	`string`	`dst`	the destination name or path of the directory
Errors	INVALID_ARGUMENT		`src` is not a directory
	NOT_FOUND		`src` is not found, or the path to `dst` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`src` or `dst` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	copyFile
Description	Copies a file to another path. The detination path may be a file or directory. If the destination is a file and exists, the destination is only replaced if `overwrite()` is `true`. If the destination is a directory and does not exist, the missing directories are only created if `createMissingPaths()` is `true`.
Parameters	`osid.id.Id`	`src`	the source `Id` of the file
Parameters	`string`	`dst`	the destination name or path of the directory or file
Return	`osid.filing.File`		the new file
Errors	ALREADY_EXISTS		`dst` exists and `overwrite()` is `false`
	INVALID_ARGUMENT		`src` is not a file
	NOT_FOUND		`src` is not found, or the path to `dst` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`src` or `dst` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	copyDirectory
Description	Copies a directory and all of its contents to another path. The destination must be a directory and if exists, the source directory is placed as a child to the given directory. If a path component in the destination does not exist, the path is created is `createMissingPaths()` is `true`.
Parameters	`osid.id.Id`	`src`	the source `Id` of the directory
Parameters	`string`	`dst`	the destination name or path of the directory
Return	`osid.filing.Directory`		the new file
Errors	INVALID_ARGUMENT		`src` is not a directory
	NOT_FOUND		`src` is not found, or the path to `dst` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`src` or `dst` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	linkFile
Description	Creates a link from one file to another.
Parameters	`osid.id.Id`	`fileId`	the `Id` of a file
Parameters	`string`	`link`	the link path
Return	`osid.filing.File`		the link
Errors	ALREADY_EXISTS		`link already` exists
	NOT_FOUND		`fileId` is not found, or the path to `link` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`fileId` or `link` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	linkDirectory
Description	Creates a link from one directory to another.
Parameters	`osid.id.Id`	`directoryId`	the `Id` of a directory
Parameters	`string`	`link`	the destination path
Return	`osid.filing.Directory`		the link
Errors	ALREADY_EXISTS		`link already` exists
	NOT_FOUND		`directoryId` is not found, or the path to `link` is not found and `createMissingPaths()` is `false`
	NULL_ARGUMENT		`directoryId` or `link` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.