com.ibm.di.api.remote
Interface TombstoneManager

All Superinterfaces:

Remote

All Known Implementing Classes:

TombstoneManagerImpl

public interface TombstoneManager
extends Remote

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

Method Summary

int	deleteALTombstones(String aAssemblyLineName, String aConfigID) Deletes all tombstones for specified AssemblyLine.
int	deleteALTombstones(String aAssemblyLineName, String aConfigID, Date olderThan) Deletes all tombstones for the specified AssemblyLine that are older than the specified number of days.
int	deleteALTombstones(String aAssemblyLineName, String aConfigID, Date startDate, Date endDate) Deletes all tombstones for the specified AssemblyLine that are in the specified Date range
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.
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	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	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,
                              RemoteException

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.

RemoteException - if a communication-related exception occurs.

getAssemblyLineTombstones

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

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.

RemoteException - if a communication-related exception occurs.

getAssemblyLineTombstones

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

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 - if an error occurs while getting the Tombstone objects.

RemoteException - if a communication-related exception occurs.

Since:

6.1.1

getAssemblyLineTombstones

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

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.

RemoteException - if a communication-related exception occurs.

getConfigInstanceTombstones

Tombstone[] getConfigInstanceTombstones(String aConfigID)
                                        throws DIException,
                                               RemoteException

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.

RemoteException - if a communication-related exception occurs.

getConfigInstanceTombstones

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

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.

RemoteException - if a communication-related exception occurs.

getTombstones

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

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.

RemoteException - if a communication-related exception occurs.

deleteTombstones

int deleteTombstones(int aDays)
                     throws DIException,
                            RemoteException

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.

RemoteException - if a communication-related exception occurs.

keepMostRecentTombstones

int keepMostRecentTombstones(int aMostResentToKeep)
                             throws DIException,
                                    RemoteException

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.

RemoteException - if a communication-related exception occurs.

deleteALTombstones

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

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.

RemoteException - if a communication-related exception occurs.

deleteALTombstones

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

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.

RemoteException - if a communication-related exception occurs.

deleteALTombstones

int deleteALTombstones(String aAssemblyLineName,
                       String aConfigID,
                       Date olderThan)
                       throws DIException,
                              RemoteException

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.

olderThan - Date.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

RemoteException - if a communication-related exception occurs.

deleteALTombstones

int deleteALTombstones(String aAssemblyLineName,
                       String aConfigID,
                       Date startDate,
                       Date endDate)
                       throws DIException,
                              RemoteException

Deletes all tombstones for the specified AssemblyLine that are in the specified Date range

Parameters:

aAssemblyLineName - The AssemblyLine name.

aConfigID - The AssemblyLine's configuration name.

startDate - Date.

endDate - Date.

Returns:

The number of deleted tombstone records.

Throws:

DIException - if an error occurs while deleting Tombstone records.

RemoteException - if a communication-related exception occurs.

keepMostRecentALTombstones

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

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.

RemoteException - if a communication-related exception occurs.

deleteCITombstones

int deleteCITombstones(String aConfigID)
                       throws DIException,
                              RemoteException

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.

RemoteException - if a communication-related exception occurs.

deleteCITombstones

int deleteCITombstones(String aConfigID,
                       int aDays)
                       throws DIException,
                              RemoteException

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.

RemoteException - if a communication-related exception occurs.

keepMostRecentCITombstones

int keepMostRecentCITombstones(String aConfigID,
                               int aMostResentToKeep)
                               throws DIException,
                                      RemoteException

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.

RemoteException - if a communication-related exception occurs.

deleteTombstone

boolean deleteTombstone(String aGUID)
                        throws DIException,
                               RemoteException

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.

RemoteException - if a communication-related exception occurs.