com.sap.caf.eu.gp.process.rt.api

Interface IGPNotificationManager

public interface IGPNotificationManager

Method Summary

IGPNotificationInstance	retrieveNotification(String processInstanceID, String activityInstanceID, String notificationID) Retrieves the last version of the notification instance corresponding to the given parameters.
IGPNotificationInstanceEnumeration	retrieveNotificationHistory(String processInstanceID, String activityInstanceID, String notificationID) Retrieves the notification instance history corresponding to the given parameters.
void	updateNotification(String processInstanceID, String activityInstanceID, String notificationID, IGPDeadline deadline) Updates the notification instance with the given deadline.
void	updateNotificationStatus(String processInstanceID, String activityInstanceID, String notificationID, int newStatus) Updates the status of the queue item that corresponds to the given parameters.

Method Detail

retrieveNotification

IGPNotificationInstance retrieveNotification(String processInstanceID,
                                             String activityInstanceID,
                                             String notificationID)
                                             throws GPInvocationException,
                                                    GPEngineException

Retrieves the last version of the notification instance corresponding to the given parameters.

Parameters:

processInstanceID - the instance ID of the process. Cannot be null

activityInstanceID - the instance ID of the activity. Can be null if the notifications are defined at the process level

notificationID - the ID of the notification

Returns:

Throws:

GPInvocationException

GPEngineException

retrieveNotificationHistory

IGPNotificationInstanceEnumeration retrieveNotificationHistory(String processInstanceID,
                                                               String activityInstanceID,
                                                               String notificationID)
                                                               throws GPInvocationException,
                                                                      GPEngineException

Retrieves the notification instance history corresponding to the given parameters.

Parameters:

processInstanceID - the instance ID of the process. Cannot be null

activityInstanceID - the instance ID of the activity. Can be null if the notifications are defined at the process level

notificationID - the ID of the notification

Returns:

Throws:

GPInvocationException

GPEngineException

updateNotificationStatus

void updateNotificationStatus(String processInstanceID,
                              String activityInstanceID,
                              String notificationID,
                              int newStatus)
                              throws GPEngineException,
                                     GPInvocationException

Updates the status of the queue item that corresponds to the given parameters.

Parameters:

processInstanceID - the instance ID of the process. Cannot be null

activityInstanceID - the instance ID of the activity. Can be null if the notifications are defined at the process level

notificationID - the ID of the notification

newStatus - the new status of the notification. Has to be one of those defined in the INotificationInstance

Throws:

GPInvocationException

GPEngineException

See Also:

INotificationInstance

updateNotification

void updateNotification(String processInstanceID,
                        String activityInstanceID,
                        String notificationID,
                        IGPDeadline deadline)
                        throws GPEngineException,
                               GPInvocationException

Updates the notification instance with the given deadline. A new version is automatically created and the old version has the deprecated status.

Parameters:

processInstanceID - the instance ID of the process. Cannot be null

activityInstanceID - the instance ID of the activity. Can be null if the notifications are defined at the process level

notificationID - the ID of the notification

deadline -

Throws:

GPEngineException

GPInvocationException

See Also:

INotificationInstance, IDeadline