org.osid.installation

Interface DepotReceiver

All Superinterfaces:

OsidReceiver

public interface DepotReceiver
extends OsidReceiver

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

Method Summary

Methods

Modifier and Type	Method and Description
void	changedDepots(IdList depotIds) The callback for notification of updated depots.
void	deletedAncestorDepot(Id depotId, Id ancestorId) The callback for notifications of deleted depot ancestors.
void	deletedDepots(IdList depotIds) The callback for notification of deleted depots.
void	deletedDescendantDepot(Id depotId, Id descendantId) The callback for notifications of deleted depot descendants.
void	newAncestorDepot(Id depotId, Id ancestorId) The callback for notifications of new depot ancestors.
void	newDepots(IdList depotIds) The callback for notifications of new depots.
void	newDescendantDepot(Id depotId, Id descendantId) The callback for notifications of new depot descendants.
void	restructuredDepotHierarchy() The callback for notifications of changes to a depot hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newDepots

void newDepots(IdList depotIds)

The callback for notifications of new depots.

Parameters:

depotIds - the Ids of the new Depots

Compliance:

mandatory - This method must be implemented.

newAncestorDepot

void newAncestorDepot(Id depotId,
                    Id ancestorId)

The callback for notifications of new depot ancestors.

Parameters:

depotId - the Id of the Depot

ancestorId - hasRecordType(depotRecordType) is false

Compliance:

mandatory - This method must be implemented.

newDescendantDepot

void newDescendantDepot(Id depotId,
                      Id descendantId)

The callback for notifications of new depot descendants.

Parameters:

depotId - the Id of the Depot

descendantId - the Id of the new Depot descendant

Compliance:

mandatory - This method must be implemented.

changedDepots

void changedDepots(IdList depotIds)

The callback for notification of updated depots.

Parameters:

depotIds - the Ids of the updated Depots

Compliance:

mandatory - This method must be implemented.

deletedDepots

void deletedDepots(IdList depotIds)

The callback for notification of deleted depots.

Parameters:

depotIds - the Ids of the deleted Depots

Compliance:

mandatory - This method must be implemented.

deletedAncestorDepot

void deletedAncestorDepot(Id depotId,
                        Id ancestorId)

The callback for notifications of deleted depot ancestors.

Parameters:

depotId - the Id of the Depot

ancestorId - the Id of the removed Depot ancestor

Compliance:

mandatory - This method must be implemented.

deletedDescendantDepot

void deletedDescendantDepot(Id depotId,
                          Id descendantId)

The callback for notifications of deleted depot descendants.

Parameters:

depotId - the Id of the Depot

descendantId - the Id of the removed Depot descendant

Compliance:

mandatory - This method must be implemented.

restructuredDepotHierarchy

void restructuredDepotHierarchy()

The callback for notifications of changes to a depot hierarchy where the hierarchy needs to refreshed.

Compliance:

mandatory - This method must be implemented.