OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.DirectoryNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Directories. 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 directories located in descendants of this directory

isolated view: includes notifcations of directories in this directory only

MethodgetDirectoryId
Description

Gets the Id of this directory.

Returnosid.id.Idthe Id of this directory
CompliancemandatoryThis method must be implemented.
MethodgetDirectory
Description

Gets the Directory associated with this session.

Returnosid.filing.Directorythe Directory associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForDirectoryNotifications
Description

Tests if this user can register for Directory 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedDirectoryView
Description

Federates the view for methods in this session. A federated view will include directories in directories which are children of this directory.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDirectoryView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this diretory only.

CompliancemandatoryThis method is must be implemented.
MethodreliableDirectoryNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeDirectoryNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableDirectoryNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeDirectoryNotification
Description

Acknowledge a directory notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewDirectories
Description

Register for notifications of new directories. DirectoryReceiver.newDirectories() is invoked when a new Directory is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDirectories
Description

Registers for notification of updated directories. DirectoryReceiver.changedDirectories() is invoked when a file is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedDirectory
Description

Registers for notification of an updated file. DirectoryReceiver.changedDirectories() is invoked when the specified directory is changed.

Parametersosid.id.IddirectoryIdthe Id of the directory to monitor
ErrorsNULL_ARGUMENT directoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDirectories
Description

Registers for notification of deleted directories. DirectoryReceiver.deletedDirectories() is invoked when a directory is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDirectory
Description

Registers for notification of a deleted directory. DirectoryReceiver.changedDirectories() is invoked when the specified directory is deleted.

Parametersosid.id.IddirectoryIdthe Id of the directory to monitor
ErrorsNULL_ARGUMENT directoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.