Interface | osid.filing.FileNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to 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 | ||
Return | osid.id.Id | the Id of this directory | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectory | ||
Description |
Gets the | ||
Return | osid.filing.Directory | the Directory associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForFileNotifications | ||
Description |
Tests if this user can register for | ||
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 | ||
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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFiles | ||
Description |
Register for notifications of new files. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFiles | ||
Description |
Registers for notification of updated files. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFile | ||
Description |
Registers for notification of an updated file. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFile | ||
Description |
Registers for notification of a deleted file. | ||
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. |