org.osid.billing

Interface PeriodNotificationSession

All Superinterfaces:

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

public interface PeriodNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Period objects in this Business. This also includes existing periods that may appear or disappear due to changes in the Business hierarchy, 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.

The two views defined in this session correspond to the views in the PeriodLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgePeriodNotification(Id notificationId) Acknowledge a period notification.
boolean	canRegisterForPeriodNotifications() Tests if this user can register for Period notifications.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
void	registerForChangedPeriod(Id periodId) Registers for notification of an updated period.
void	registerForChangedPeriods() Registers for notification of updated customers.
void	registerForDeletedPeriod(Id periodId) Registers for notification of a deleted period.
void	registerForDeletedPeriods() Registers for notification of deleted periods.
void	registerForNewPeriods() Register for notifications of new periods.
void	reliablePeriodNotifications() Reliable notifications are desired.
void	unreliablePeriodNotifications() Unreliable notifications are desired.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() 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

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForPeriodNotifications

boolean canRegisterForPeriodNotifications()

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

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include periods in catalogs which are children of this catalog in the business hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBusinessView

void useIsolatedBusinessView()

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

Compliance:

mandatory - This method is must be implemented.

reliablePeriodNotifications

void reliablePeriodNotifications()

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

Compliance:

mandatory - This method is must be implemented.

unreliablePeriodNotifications

void unreliablePeriodNotifications()

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

Compliance:

mandatory - This method is must be implemented.

acknowledgePeriodNotification

void acknowledgePeriodNotification(Id notificationId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Acknowledge a period notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPeriods

void registerForNewPeriods()
                           throws OperationFailedException,
                                  PermissionDeniedException

Register for notifications of new periods. PeriodReceiver.newPeriods() is invoked when a new Period appears in this business.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPeriods

void registerForChangedPeriods()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of updated customers. PeriodReceiver.changedPeriods() is invoked when a period in this business is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPeriod

void registerForChangedPeriod(Id periodId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated period. PeriodReceiver.changedPeriods() is invoked when the specified period in this business is changed.

Parameters:

periodId - the Id of the Period to monitor

Throws:

NullArgumentException - periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPeriods

void registerForDeletedPeriods()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of deleted periods. PeriodReceiver.deletedPeriods() is invoked when a period is deleted or removed from this business.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPeriod

void registerForDeletedPeriod(Id periodId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted period. PeriodReceiver.deletedPeriods() is invoked when the specified period is deleted or removed from this business.

Parameters:

periodId - the Id of the Period to monitor

Throws:

NullArgumentException - periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.