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

Interface IGPNotificationInstance

public interface IGPNotificationInstance

Field Summary

static int	NOTIFICATION_STATUS_CANCELLED The notification is cancelled because the activity was completed before the time of processing of the notification
static int	NOTIFICATION_STATUS_DEPRECATED the notification instance is deprecated.
static int	NOTIFICATION_STATUS_ERROR An error occured during the processing of the notification.
static int	NOTIFICATION_STATUS_EXECUTED The notification is executed.
static int	NOTIFICATION_STATUS_WAITING Status of the notification when it is not yet processed The notification is waiting in the queue to be processed

Method Summary

String	getActivityInstanceID() Returns the activity instance ID of the notification instance.
long	getCreationDate() Returns the timestamp of the creation of this version of the notification.
IGPDeadline	getDeadline() Returns the deadline of the Notification
long	getLastChangedDate() Returns the timestamp of the last status changed of this version of the notification.
String	getNotificationID() Returns the notification ID (corresponds to the Design Time ID)
String	getProcessInstanceID() Returns the process instance ID of the notification instance
String	getProcessRoleName() Returns the process role name of the notification.
int	getStatus() Returns the status of the notification instance.
int	getVersion() Returns the version of the notification
boolean	isDueDateNotification() Returns true whether the Notification is the one defined for the due date.

Field Detail

NOTIFICATION_STATUS_WAITING

static final int NOTIFICATION_STATUS_WAITING

Status of the notification when it is not yet processed The notification is waiting in the queue to be processed

See Also:

Constant Field Values

NOTIFICATION_STATUS_DEPRECATED

static final int NOTIFICATION_STATUS_DEPRECATED

the notification instance is deprecated. A more up-to-date version exists.

See Also:

Constant Field Values

NOTIFICATION_STATUS_EXECUTED

static final int NOTIFICATION_STATUS_EXECUTED

The notification is executed.

See Also:

Constant Field Values

NOTIFICATION_STATUS_CANCELLED

static final int NOTIFICATION_STATUS_CANCELLED

The notification is cancelled because the activity was completed before the time of processing of the notification

See Also:

Constant Field Values

NOTIFICATION_STATUS_ERROR

static final int NOTIFICATION_STATUS_ERROR

An error occured during the processing of the notification.

See Also:

Constant Field Values

Method Detail

getDeadline

IGPDeadline getDeadline()

Returns the deadline of the Notification

Returns:

getProcessRoleName

String getProcessRoleName()

Returns the process role name of the notification.

Returns:

getVersion

int getVersion()

Returns the version of the notification

Returns:

getProcessInstanceID

String getProcessInstanceID()

Returns the process instance ID of the notification instance

Returns:

getActivityInstanceID

String getActivityInstanceID()

Returns the activity instance ID of the notification instance.

Returns:

getNotificationID

String getNotificationID()

Returns the notification ID (corresponds to the Design Time ID)

Returns:

getStatus

int getStatus()

Returns the status of the notification instance.

Returns:

isDueDateNotification

boolean isDueDateNotification()

Returns true whether the Notification is the one defined for the due date.

Returns:

getLastChangedDate

long getLastChangedDate()

Returns the timestamp of the last status changed of this version of the notification.

Returns:

getCreationDate

long getCreationDate()

Returns the timestamp of the creation of this version of the notification.

Returns: