OSID - osid.filing.FileNotificationSession Service Interface Definition

Interface	osid.filing.FileNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.filing.FilingManager`
Used By	`osid.filing.FilingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Files`. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. Two view are defined in this session: federated view: includes notifications of files located in subdirectories in this directory isolated view: includes notifcations of files 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	canRegisterForFileNotifications
Description	Tests if this user can register for `File` notifications. 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 notification operations.
Return	`boolean`		`false` if notification 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 files 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 notifications to this diretory only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableFileNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeFileNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableFileNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeFileNotification
Description	Acknowledge a file notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewFiles
Description	Register for notifications of new files. `FileReceiver.newFiles()` is invoked when a new `File` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFiles
Description	Registers for notification of updated files. `FileReceiver.changedFiles()` is invoked when a file is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFile
Description	Registers for notification of an updated file. `FileReceiver.changedFiles()` is invoked when the specified file is changed.
Parameters	`osid.id.Id`	`fileId`	the `Id` of the file
Errors	NULL_ARGUMENT		`fileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFiles
Description	Registers for notification of deleted files. `FileReceiver.deletedFiles()` is invoked when a file is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFile
Description	Registers for notification of a deleted file. `FileReceiver.changedFiles()` is invoked when the specified file is deleted.
Parameters	`osid.id.Id`	`fileId`	the `Id` of the file
Errors	NULL_ARGUMENT		`fileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.