com.ibm.di.api.local
Interface TombstoneManager

All Known Implementing Classes:

TombstoneManagerImpl

public interface TombstoneManager

Represents a TombstoneManager instance. Provides various methods to deal with Tombstones.

Method Summary

int	deleteALTombstones(String aAssemblyLineName, String aConfigID) Deletes all tombstones for specified AssemblyLine.
int	deleteALTombstones(String aAssemblyLineName, String aConfigID, int aDays) Deletes all tombstones for the specified AssemblyLine that are older than the specified number of days.
int	deleteCITombstones(String aConfigID) Deletes all tombstones for specified Config Instance.
int	deleteCITombstones(String aConfigID, int aDays) Deletes all tombstones for the specified Config Instance that are older than the specified number of days.
int	deleteEHTombstones(String aEventHandlerName, String aConfigID) Deletes all tombstones for specified EventHandler.
int	deleteEHTombstones(String aEventHandlerName, String aConfigID, int aDays) Deletes all tombstones for the specified EventHandler that are older than the specified number of days.
boolean	deleteTombstone(String aGUID) Deletes the tombstone with the specified GUID.
int	deleteTombstones(int aDays) Deletes all tombstones that are older than the specified number of days.
Tombstone[]	getAssemblyLineTombstones(String aAssemblyLineName, String aConfigID) Returns all available tombstones for the specified AssemblyLine.
Tombstone[]	getAssemblyLineTombstones(String aAssemblyLineName, String aConfigID, Date aStartTime, Date aEndTime) Returns all available tombstones for the specified AssemblyLine with timestamps in the interval specified by aStartTime and aEndTime.
Tombstone[]	getAssemblyLineTombstones(String aAssemblyLineName, String aConfigID, int aRecentNumberOfTombstones) Returns the recent n number of tombsones for a specified AssemblyLine.
Tombstone[]	getConfigInstanceTombstones(String aConfigID) Returns all available tombstones for the specified Config Instance.
Tombstone[]	getConfigInstanceTombstones(String aConfigID, Date aStartTime, Date aEndTime) Returns all available tombstones for the specified Config Instance with timestamps in the interval specified by aStartTime and aEndTime.
Tombstone[]	getEventHandlerTombstones(String aEventHandlerName, String aConfigID) Returns all available tombstones for the specified EventHandler.
Tombstone[]	getEventHandlerTombstones(String aEventHandlerName, String aConfigID, Date aStartTime, Date aEndTime) Returns all available tombstones for the specified EventHandler with timestamps in the interval specified by aStartTime and aEndTime.
Tombstone	getTombstone(String aGUID) Returns a single tombstone object uniquely identified by the specified GUID.
Tombstone[]	getTombstones(Date aStartTime, Date aEndTime) Returns all available tombstones with timestamps in the interval specified by aStartTime and aEndTime.
int	keepMostRecentALTombstones(String aAssemblyLineName, String aConfigID, int aMostResentToKeep) After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified AssemblyLine are kept and all other are deleted.
int	keepMostRecentCITombstones(String aConfigID, int aMostResentToKeep) After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified Config Instance are kept and all other are deleted.
int	keepMostRecentEHTombstones(String aEventHandlerName, String aConfigID, int aMostResentToKeep) After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified EventHandler are kept and all other are deleted.
int	keepMostRecentTombstones(int aMostResentToKeep) After this method is executed only the aMostRecentToKeep most recent tombstone records are kept and all other are deleted.

Method Detail

getTombstone

Tombstone getTombstone(String aGUID)
                       throws DIException

Returns a single tombstone object uniquely identified by the specified GUID.

Parameters:

aGUID - Tombstone GUID.

Returns:

the Tombstone object.

Throws:

DIException - if an error occurs while getting the Tombstone object.

getAssemblyLineTombstones

Tombstone[] getAssemblyLineTombstones(String aAssemblyLineName,
                                      String aConfigID)
                                      throws DIException

Returns all available tombstones for the specified AssemblyLine.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aConfigID - The name of the AssmeblyLine's configuration.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects.

getAssemblyLineTombstones

Tombstone[] getAssemblyLineTombstones(String aAssemblyLineName,
                                      String aConfigID,
                                      int aRecentNumberOfTombstones)
                                      throws DIException

Returns the recent n number of tombsones for a specified AssemblyLine.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aConfigID - The name of the AssmeblyLine's configuration.

aRecentNumberOfTombstones - The recent n number of tombsones to be returned.

Returns:

an array of Tombstone objects.

Throws:

DIException

Since:

6.1.1

getAssemblyLineTombstones

Tombstone[] getAssemblyLineTombstones(String aAssemblyLineName,
                                      String aConfigID,
                                      Date aStartTime,
                                      Date aEndTime)
                                      throws DIException

Returns all available tombstones for the specified AssemblyLine with timestamps in the interval specified by aStartTime and aEndTime.

Parameters:

aAssemblyLineName - The name of the AssemblyLine.

aConfigID - The name of the AssmeblyLine's configuration.

aStartTime - peroid start time.

aEndTime - period end time.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified AssemblyLine.

getEventHandlerTombstones

Tombstone[] getEventHandlerTombstones(String aEventHandlerName,
                                      String aConfigID)
                                      throws DIException

Returns all available tombstones for the specified EventHandler.

Parameters:

aEventHandlerName - The name of the Eventhandler.

aConfigID - The name of the EventHandler's configuration.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified EventHandler.

getEventHandlerTombstones

Tombstone[] getEventHandlerTombstones(String aEventHandlerName,
                                      String aConfigID,
                                      Date aStartTime,
                                      Date aEndTime)
                                      throws DIException

Returns all available tombstones for the specified EventHandler with timestamps in the interval specified by aStartTime and aEndTime.

Parameters:

aEventHandlerName - The name of the Eventhandler.

aConfigID - The name of the EventHandler's configuration.

aStartTime - peroid start time.

aEndTime - period end time.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified EventHandler.

getConfigInstanceTombstones

Tombstone[] getConfigInstanceTombstones(String aConfigID)
                                        throws DIException

Returns all available tombstones for the specified Config Instance.

Parameters:

aConfigID - The configuration name.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified Config Instance.

getConfigInstanceTombstones

Tombstone[] getConfigInstanceTombstones(String aConfigID,
                                        Date aStartTime,
                                        Date aEndTime)
                                        throws DIException

Returns all available tombstones for the specified Config Instance with timestamps in the interval specified by aStartTime and aEndTime.

Parameters:

aConfigID - The configuration name.

aStartTime - peroid start time.

aEndTime - period end time.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified Config Instance.

getTombstones

Tombstone[] getTombstones(Date aStartTime,
                          Date aEndTime)
                          throws DIException

Returns all available tombstones with timestamps in the interval specified by aStartTime and aEndTime.

Parameters:

aStartTime - peroid start time.

aEndTime - period end time.

Returns:

an array of Tombstone objects.

Throws:

DIException - if an error occurs while getting the Tombstone objects for the specified interval.

deleteTombstones

int deleteTombstones(int aDays)
                     throws DIException

Deletes all tombstones that are older than the specified number of days.

Parameters:

aDays - Number of days.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

keepMostRecentTombstones

int keepMostRecentTombstones(int aMostResentToKeep)
                             throws DIException

After this method is executed only the aMostRecentToKeep most recent tombstone records are kept and all other are deleted.

Parameters:

aMostResentToKeep - number of most recent tombstones to keep.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteALTombstones

int deleteALTombstones(String aAssemblyLineName,
                       String aConfigID)
                       throws DIException

Deletes all tombstones for specified AssemblyLine.

Parameters:

aAssemblyLineName - The AssemblyLine name.

aConfigID - The AssemblyLine's configuration name.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteALTombstones

int deleteALTombstones(String aAssemblyLineName,
                       String aConfigID,
                       int aDays)
                       throws DIException

Deletes all tombstones for the specified AssemblyLine that are older than the specified number of days.

Parameters:

aAssemblyLineName - The AssemblyLine name.

aConfigID - The AssemblyLine's configuration name.

aDays - Number of days.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

keepMostRecentALTombstones

int keepMostRecentALTombstones(String aAssemblyLineName,
                               String aConfigID,
                               int aMostResentToKeep)
                               throws DIException

After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified AssemblyLine are kept and all other are deleted.

Parameters:

aAssemblyLineName - The AssemblyLine name.

aConfigID - The AssemblyLine's configuration name.

aMostResentToKeep - Number of most recent tombstones to keep.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteEHTombstones

int deleteEHTombstones(String aEventHandlerName,
                       String aConfigID)
                       throws DIException

Deletes all tombstones for specified EventHandler.

Parameters:

aEventHandlerName - The EventHandler name.

aConfigID - The EventHandler's configuration name.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteEHTombstones

int deleteEHTombstones(String aEventHandlerName,
                       String aConfigID,
                       int aDays)
                       throws DIException

Deletes all tombstones for the specified EventHandler that are older than the specified number of days.

Parameters:

aEventHandlerName - The EventHandler name.

aConfigID - The EventHandler's configuration name.

aDays - number of days.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

keepMostRecentEHTombstones

int keepMostRecentEHTombstones(String aEventHandlerName,
                               String aConfigID,
                               int aMostResentToKeep)
                               throws DIException

After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified EventHandler are kept and all other are deleted.

Parameters:

aEventHandlerName - The EventHandler's name.

aConfigID - The EventHandler's configuration name.

aMostResentToKeep - Number of most recent tombstones to keep.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteCITombstones

int deleteCITombstones(String aConfigID)
                       throws DIException

Deletes all tombstones for specified Config Instance.

Parameters:

aConfigID - Configuration name.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteCITombstones

int deleteCITombstones(String aConfigID,
                       int aDays)
                       throws DIException

Deletes all tombstones for the specified Config Instance that are older than the specified number of days.

Parameters:

aConfigID - Configuration name.

aDays - Number of days.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

keepMostRecentCITombstones

int keepMostRecentCITombstones(String aConfigID,
                               int aMostResentToKeep)
                               throws DIException

After this method is executed only the aMostRecentToKeep most recent tombstone records for the specified Config Instance are kept and all other are deleted.

Parameters:

aConfigID - Configuration name.

aMostResentToKeep - Number of most recent tombstones to keep.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

deleteTombstone

boolean deleteTombstone(String aGUID)
                        throws DIException

Deletes the tombstone with the specified GUID.

Parameters:

aGUID - Tombstone GUID.

Returns:

true only when the tombstone object with the specified GUID is found and deleted.

Throws:

DIException - if an error occurs while deleting Tombstone record.