curam.core.facade.intf

Interface Alert

All Known Implementing Classes:

Alert, curam.core.facade.impl.Alert, AlertFactory

@AccessLevel(value=EXTERNAL)
public interface Alert

Notifications are used to inform a user that an event has occurred. Notifications may be delivered as alerts and are displayed in the user Inbox. This class provides the operations used to view and maintain alerts.

Method Summary

Modifier and Type	Method and Description
void	create(curam.core.facade.struct.CreateAlertDetails createAlertDetails) Creates an alert.
curam.core.facade.struct.AlertMultiRemoveKey	getAlertIDsForRemoval(curam.core.facade.struct.AlertMultiRemoveKey alertRemoveKey) Returns a comma-delimited list of alert identifiers for removal.
curam.core.facade.struct.AlertSummaryDetailsList	listAlerts() Returns a list of alerts for the currently logged in user.
curam.core.facade.struct.AlertContextDescription	readContextDescription(curam.core.facade.struct.AlertContextKey alertContextKey) Returns the context description for an alert.
void	remove(curam.core.facade.struct.AlertKey alertKey) Removes an alert.
void	removeSelected(curam.core.facade.struct.AlertMultiRemoveKey alertMultiRemoveKey) Removes the alerts specified in the comma-delimited list.
curam.core.facade.struct.ViewAlertDetails	view(curam.core.facade.struct.AlertKey alertKey) Returns the details of an alert.
curam.core.facade.struct.AlertWorkflowGraphDetails	viewProcessInstanceForAlert(curam.core.facade.struct.AlertKey alertKey) Returns the XML representing the graph of the process instance associated with the specified alert.
curam.core.facade.pdt.struct.WorkflowGraphDetails	visualiseProcessInstanceForAlert(curam.core.facade.struct.AlertKey alertKey) Deprecated. Since Bluewash 6.0.3.0, this method has been replaced by viewProcessInstanceForAlert(AlertKey). See Release Note CR00309046.

Method Detail

view

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewAlertDetails view(curam.core.facade.struct.AlertKey alertKey)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Returns the details of an alert. These details include the alert subject in the current user locale and also a list of the actions associated with the alert.

Parameters:

alertKey - The identifier of the alert whose details will be returned.

Returns:

The details of the alert.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

remove

@AccessLevel(value=EXTERNAL)
void remove(curam.core.facade.struct.AlertKey alertKey)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Removes an alert. Note that this is a physical rather than a logical removal of the record from the associated Alert database table.

Parameters:

alertKey - The unique identifier of the alert to remove.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

create

@AccessLevel(value=EXTERNAL)
void create(curam.core.facade.struct.CreateAlertDetails createAlertDetails)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Creates an alert.

Parameters:

createAlertDetails - the details of the new alert.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AlertContextDescription readContextDescription(curam.core.facade.struct.AlertContextKey alertContextKey)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns the context description for an alert. The context description includes the full name of the user associated with the alert.

Parameters:

alertContextKey - The details required to generate the alert context. In this scenario, this is the user name.

Returns:

the context description details associated with an alert.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

visualiseProcessInstanceForAlert

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.pdt.struct.WorkflowGraphDetails visualiseProcessInstanceForAlert(curam.core.facade.struct.AlertKey alertKey)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Deprecated. Since Bluewash 6.0.3.0, this method has been replaced by viewProcessInstanceForAlert(AlertKey). See Release Note CR00309046.

Returns the XML representing the graph of the process instance associated with the specified alert. This graph includes the activities and transitions of the workflow process and also highlights the activity that was executed to generate the alert.

Parameters:

alertKey - The unique identifier of the alert whose graphical representation will be returned.

Returns:

The XML representing the graph of the process instance associated with the specified alert.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getAlertIDsForRemoval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AlertMultiRemoveKey getAlertIDsForRemoval(curam.core.facade.struct.AlertMultiRemoveKey alertRemoveKey)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Returns a comma-delimited list of alert identifiers for removal.

Parameters:

alertRemoveKey - A tab delimited list of alert identifiers for removal. This tab delimited list is converted into a comma-delimited list by this operation.

Returns:

A comma-delimited list of alert identifiers for removal.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeSelected

@AccessLevel(value=EXTERNAL)
void removeSelected(curam.core.facade.struct.AlertMultiRemoveKey alertMultiRemoveKey)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Removes the alerts specified in the comma-delimited list. Note that this is a physical rather than a logical removal of the records from the associated Alert database table.

Parameters:

alertMultiRemoveKey - A comma-delimited list of identifiers for the alerts to remove.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAlerts

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AlertSummaryDetailsList listAlerts()
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Returns a list of alerts for the currently logged in user. This method limits the number of alerts that are returned to the client. The limit is governed by the ENV_NOTIFICATION_MAX_LIST_SIZE environment variable. If the number of records exceed this maximum value then an information message is displayed (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

Returns:

A list of the alert details for the currently logged in user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewProcessInstanceForAlert

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AlertWorkflowGraphDetails viewProcessInstanceForAlert(curam.core.facade.struct.AlertKey alertKey)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns the XML representing the graph of the process instance associated with the specified alert. This graph includes the activities and transitions of the workflow process and also highlights the activity that was executed to generate the alert.

Parameters:

alertKey - The unique identifier of the alert whose graphical representation will be returned.

Returns:

The XML representing the graph of the process instance associated with the specified alert.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException