org.osid.personnel

Interface OrganizationNotificationSession

All Superinterfaces:

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

public interface OrganizationNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Organization 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	canRegisterForOrganizationNotifications() Tests if this user can register for Organization notifications.
Realm	getRealm() Gets the Realm associated with this session.
Id	getRealmId() Gets the Realm Id associated with this session.
void	registerForChangedOrganization(Id organizationId) Registers for notification of an updated organization.
void	registerForChangedOrganizations() Registers for notification of updated organizations.
void	registerForDeletedOrganization(Id organizationId) Registers for notification of a deleted organization.
void	registerForDeletedOrganizationAncestors(Id organizationId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified organization.
void	registerForDeletedOrganizationDescendants(Id organizationId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified organization.
void	registerForDeletedOrganizations() Registers for notification of deleted organizations.
void	registerForNewOrganizationAncestors(Id organizationId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified organization.
void	registerForNewOrganizationDescendants(Id organizationId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified organization.
void	registerForNewOrganizations() Register for notifications of new organizations.
void	useFederatedRealmView() Federates the view for methods in this session.
void	useIsolatedRealmView() Isolates the view for methods in this session.

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

getRealmId

Id getRealmId()

Gets the Realm Id associated with this session.

Returns:

the Realm Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealm

Realm getRealm()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Realm associated with this session.

Returns:

the realm

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForOrganizationNotifications

boolean canRegisterForOrganizationNotifications()

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

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedRealmView

void useFederatedRealmView()

Federates the view for methods in this session. A federated view will include notifications for organizations in realms which are children of this realm in the realm hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedRealmView

void useIsolatedRealmView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewOrganizations

void registerForNewOrganizations()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Register for notifications of new organizations. OrganizationReceiver.newOrganizations() is invoked when a new Organization is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOrganizationAncestors

void registerForNewOrganizationAncestors(Id organizationId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified organization. OrganizationReceiver.newAncestorOrganization() is invoked when the specified organization node gets a new ancestor.

Parameters:

organizationId - the Id of the Organization node to monitor

Throws:

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOrganizationDescendants

void registerForNewOrganizationDescendants(Id organizationId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified organization. OrganizationReceiver.newDescendantOrganization() is invoked when the specified organization node gets a new descendant.

Parameters:

organizationId - the Id of the Organization node to monitor

Throws:

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOrganizations

void registerForChangedOrganizations()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of updated organizations. OrganizationReceiver.changedOrganizations() is invoked when an organization in this realm is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOrganization

void registerForChangedOrganization(Id organizationId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Registers for notification of an updated organization. OrganizationReceiver.changedOrganizations() is invoked when the specified organization in this realm is changed.

Parameters:

organizationId - the Id of the Organization to monitor

Throws:

NotFoundException - an organization was not found identified by the given Id

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOrganizations

void registerForDeletedOrganizations()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of deleted organizations. OrganizationReceiver.deletedOrganizations() is invoked when an organization is removed from this realm.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOrganization

void registerForDeletedOrganization(Id organizationId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Registers for notification of a deleted organization. OrganizationReceiver.deletedOrganizations() is invoked when the specified organization is removed from this realm.

Parameters:

organizationId - the Id of the Organization to monitor

Throws:

NotFoundException - an organization was not found identified by the given Id

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOrganizationAncestors

void registerForDeletedOrganizationAncestors(Id organizationId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified organization. OrganizationReceiver.deletedAncestorOrganization() is invoked when the specified organization node loses an ancestor.

Parameters:

organizationId - the Id of the Organization to monitor

Throws:

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOrganizationDescendants

void registerForDeletedOrganizationDescendants(Id organizationId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes a descendant of the specified organization. Organization Receiver.deletedDescendantOrganization() is invoked when the specified organization node loses a descendant.

Parameters:

organizationId - the Id of the Organization to monitor

Throws:

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.