curam.util.workflow.impl

Interface LocalizableStringResolver.NotificationStringResolver

Enclosing class:

LocalizableStringResolver

@AccessLevel(value=EXTERNAL)
public static interface LocalizableStringResolver.NotificationStringResolver

The localizable string resolver for notification related text.

Method Summary

Modifier and Type	Method and Description
NotificationActionDetailsList	getActionsDetailsForNotification(NotificationKey notificationKey, java.lang.String wdoSnapshot) Returns details of all the notification actions of the specified notification for the current user locale.
NotificationBody	getBodyForNotification(NotificationKey notificationKey, java.lang.String wdoSnapshot) Returns the body string for the specified notification for the current locale of the user.
NotificationBodyList	getBodyForNotificationForAllLocales(NotificationKey notificationKey, java.lang.String wdoSnapshot) Returns the body string for the specified notification for all the available locales.
NotificationSubject	getSubjectForNotification(NotificationKey notificationKey, java.lang.String wdoSnapshot) Returns the subject string for the specified notification for the current locale of the user.
NotificationSubjectList	getSubjectForNotificationForAllLocales(NotificationKey notificationKey, java.lang.String wdoSnapshot) Returns the subject string for the specified notification for all the available locales.
NotificationSubjectList	getSubjectsForNotifications(NotificationDetailsList notificationDetailsList) Returns the subject strings for the specified notifications based on the current locale of the user.

Method Detail

getSubjectsForNotifications

NotificationSubjectList getSubjectsForNotifications(NotificationDetailsList notificationDetailsList)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Returns the subject strings for the specified notifications based on the current locale of the user.

Parameters:

notificationDetailsList - The list of identifiers for the notifications whose subject text strings will be returned.

Returns:

The localized text strings for the subjects of the specified notifications based on the current locale of the user.

Throws:

curam.util.exception.AppException - Exceptions that may be thrown when retrieving the subject list for the specified notifications.

curam.util.exception.InformationalException - Generic Exception Signature.

getActionsDetailsForNotification

NotificationActionDetailsList getActionsDetailsForNotification(NotificationKey notificationKey,
                                                               java.lang.String wdoSnapshot)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Returns details of all the notification actions of the specified notification for the current user locale.

Parameters:

notificationKey - The key containing the identifier of the notification whose action details will be returned.

wdoSnapshot - The snapshot of workflow data object attribute data that will be used to resolve the action message parameters that will be returned.

Returns:

The details of all the notification actions for the specified notification for the current user locale.

Throws:

curam.util.exception.AppException - Exceptions that be thrown when retrieving the list of action details for the specified notification.

curam.util.exception.InformationalException - Generic Exception Signature.

getSubjectForNotification

NotificationSubject getSubjectForNotification(NotificationKey notificationKey,
                                              java.lang.String wdoSnapshot)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Returns the subject string for the specified notification for the current locale of the user.

Parameters:

notificationKey - The details required to uniquely identify the notification whose subject string will be returned.

wdoSnapshot - A snapshot of the workflow data object attribute data required to resolve the parameters of a notification subject string.

Returns:

The subject string for the specified notification for the current locale of the user.

Throws:

curam.util.exception.AppException - Exceptions that may occur when retrieving the subject string for a specified notification.

curam.util.exception.InformationalException - Generic Exception Signature.

getBodyForNotification

NotificationBody getBodyForNotification(NotificationKey notificationKey,
                                        java.lang.String wdoSnapshot)
                                 throws curam.util.exception.AppException,
                                        curam.util.exception.InformationalException

Returns the body string for the specified notification for the current locale of the user.

Parameters:

notificationKey - The details required to uniquely identify the notification whose body string will be returned.

wdoSnapshot - A snapshot of the workflow data object attribute data required to resolve the parameters of a notification body string.

Returns:

The body string for the specified notification for the current locale of the user.

Throws:

curam.util.exception.AppException - Exceptions that may occur when retrieving the body string for a specified notification.

curam.util.exception.InformationalException - Generic Exception Signature.

getSubjectForNotificationForAllLocales

NotificationSubjectList getSubjectForNotificationForAllLocales(NotificationKey notificationKey,
                                                               java.lang.String wdoSnapshot)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Returns the subject string for the specified notification for all the available locales.

Parameters:

notificationKey - The details required to uniquely identify the notification whose subject string will be returned.

wdoSnapshot - A snapshot of the workflow data object attribute data required to resolve the parameters of a notification subject string.

Returns:

The subject string for the specified notification for all the available locales.

Throws:

curam.util.exception.AppException - Exceptions that may occur when retrieving the subject string for a specified notification.

curam.util.exception.InformationalException - Generic Exception Signature.

getBodyForNotificationForAllLocales

NotificationBodyList getBodyForNotificationForAllLocales(NotificationKey notificationKey,
                                                         java.lang.String wdoSnapshot)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Returns the body string for the specified notification for all the available locales.

Parameters:

notificationKey - The details required to uniquely identify the notification whose body string will be returned.

wdoSnapshot - A snapshot of the workflow data object attribute data required to resolve the parameters of a notification body string.

Returns:

The body string for the specified notification for all the available locales.

Throws:

curam.util.exception.AppException - Exceptions that may occur when retrieving the body string for a specified notification.

curam.util.exception.InformationalException - Generic Exception Signature.