TimePeriodReceiver

All Superinterfaces:: OsidReceiver

public interface TimePeriodReceiver extends OsidReceiver

The time period receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted TimePeriods .

Method Summary

Modifier and Type

Method

Description

void

changedTimePeriods(Id notificationId, IdList timePeriodIds)

The callback for notification of updated time periods.

void

deletedTimePeriods(Id notificationId, IdList timePeriodIds)

The callback for notification of deleted time periods.

void

newTimePeriods(Id notificationId, IdList timePeriodIds)

The callback for notifications of new time periods.

Methods inherited from interface OsidReceiver
down, up

Modifier and Type

Method

Description

void

down()

The callback for notifications that the notification bus is not operating.

void

up()

The callback for notifications that the notification bus is operational.

Method Details
- newTimePeriods
  
  void newTimePeriods(Id notificationId, IdList timePeriodIds)
  
  The callback for notifications of new time periods.
  
  Parameters:
  
  notificationId - the notification Id
  
  timePeriodIds - the Id of the new TimePeriods
  
  Compliance:
  mandatory - This method must be implemented.
- changedTimePeriods
  
  void changedTimePeriods(Id notificationId, IdList timePeriodIds)
  
  The callback for notification of updated time periods.
  
  Parameters:
  
  notificationId - the notification Id
  
  timePeriodIds - the Id of the updated TimePeriods
  
  Compliance:
  mandatory - This method must be implemented.
- deletedTimePeriods
  
  void deletedTimePeriods(Id notificationId, IdList timePeriodIds)
  
  The callback for notification of deleted time periods.
  
  Parameters:
  
  notificationId - the notification Id
  
  timePeriodIds - the Id of the deleted TimePeriods
  
  Compliance:
  mandatory - This method must be implemented.