org.thales.punch.api

Interface ICheckPointConsumer

public interface ICheckPointConsumer

Method Summary

Modifier and Type	Method and Description
String	applicationId()
void	commit(CheckPoint checkPoint)
CheckPoint	lastCommittedCheckPoint() Use this method to retrieve information of last committed checkpoint
CheckPoint	lastCommittedCheckPoint(String applicationRuntimeIdFieldName, String applicationCheckPointIntervalFieldName) Use this method to retrieve information of last committed checkpoint with a custom field name

Method Detail

commit

void commit(CheckPoint checkPoint)

Parameters:

checkPoint - which is initialized by the application who wants to commit at a given date

lastCommittedCheckPoint

CheckPoint lastCommittedCheckPoint()

Use this method to retrieve information of last committed checkpoint

Returns:

a CheckPoint object where you can get the last checkpoint date (null if no date found)

lastCommittedCheckPoint

CheckPoint lastCommittedCheckPoint(String applicationRuntimeIdFieldName,
                                   String applicationCheckPointIntervalFieldName)

Use this method to retrieve information of last committed checkpoint with a custom field name

Parameters:

applicationRuntimeIdFieldName - custom application runtime id field name

applicationCheckPointIntervalFieldName - custom application checkpoint interval field name

Returns:

a CheckPoint object where you can get the last checkpoint date (null if no date found)

applicationId

String applicationId()

Returns:

application id of this checkpoint instance