org.osid.billing

Interface PeriodReceiver

All Superinterfaces:

OsidReceiver

public interface PeriodReceiver
extends OsidReceiver

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changedPeriod(Id periodId) The callback for notification of updated periods.
void	deletedAncestorPeriod(Id periodId, Id ancestorId) The callback for notifications of deleted period ancestors.
void	deletedDescendantPeriod(Id periodId, Id descendantId) The callback for notifications of deleted period descendants.
void	deletedPeriod(Id periodId) The callback for notification of deleted periods.
void	newAncestorPeriod(Id periodId, Id ancestorId) The callback for notifications of new period ancestors.
void	newDescendantPeriod(Id periodId, Id descendantId) The callback for notifications of new period descendants.
void	newPeriod(Id periodId) The callback for notifications of new periods.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newPeriod

void newPeriod(Id periodId)

The callback for notifications of new periods.

Parameters:

periodId - the Id of the new Period

Compliance:

mandatory - This method must be implemented.

newAncestorPeriod

void newAncestorPeriod(Id periodId,
                     Id ancestorId)

The callback for notifications of new period ancestors.

Parameters:

periodId - the Id of the Period

ancestorId - the Id of the new Period ancestor

Compliance:

mandatory - This method must be implemented.

newDescendantPeriod

void newDescendantPeriod(Id periodId,
                       Id descendantId)

The callback for notifications of new period descendants.

Parameters:

periodId - the Id of the Period

descendantId - the Id of the new Period descendant

Compliance:

mandatory - This method must be implemented.

changedPeriod

void changedPeriod(Id periodId)

The callback for notification of updated periods.

Parameters:

periodId - the Id of the updated Period

Compliance:

mandatory - This method must be implemented.

deletedPeriod

void deletedPeriod(Id periodId)

The callback for notification of deleted periods.

Parameters:

periodId - the Id of the deleted Period

Compliance:

mandatory - This method must be implemented.

deletedAncestorPeriod

void deletedAncestorPeriod(Id periodId,
                         Id ancestorId)

The callback for notifications of deleted period ancestors.

Parameters:

periodId - the Id of the Period

ancestorId - the Id of the removed Period ancestor

Compliance:

mandatory - This method must be implemented.

deletedDescendantPeriod

void deletedDescendantPeriod(Id periodId,
                           Id descendantId)

The callback for notifications of deleted period descendants.

Parameters:

periodId - the Id of the Period

descendantId - the Id of the removed Period descendant

Compliance:

mandatory - This method must be implemented.