org.osid.installation

Interface InstallationNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface InstallationNotificationSession
extends OsidSession

This session defines methods to receive asynchronous notifications on adds/changes to Installation objects. 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForInstallationNotifications() Tests if this user can register for Installation notifications.
Site	getSite() Gets the Site associated with this session.
Id	getSiteId() Gets the Site Id associated with this session.
void	registerForDeletedInstallation(Id installationId) Registers for notification of a deleted installation.
void	registerForDeletedInstallations() Registers for notification of deleted installations.
void	registerForNewInstallations() Register for notifications of new installations.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSiteId

Id getSiteId()

Gets the Site Id associated with this session.

Returns:

the Site Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSite

Site getSite()
             throws OperationFailedException,
                    PermissionDeniedException

Gets the Site associated with this session.

Returns:

the Site associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForInstallationNotifications

boolean canRegisterForInstallationNotifications()

Tests if this user can register for Installation 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 not offer notification functions to unauthorized users.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewInstallations

void registerForNewInstallations()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Register for notifications of new installations. InstallationReceiver.newInstallations() is invoked when a new installation is installed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInstallations

void registerForDeletedInstallations()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of deleted installations. InstallationReceiver.deletedInstallations() is invoked when a installation is removed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedInstallation

void registerForDeletedInstallation(Id installationId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of a deleted installation. InstallationReceiver.deletedInstallations() is invoked when the specified installation is removed.

Parameters:

installationId - the Id of the Installation to monitor

Throws:

NullArgumentException - installationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.