curam.util.workflow.impl

Interface LocalizableStringResolver.TaskStringResolver

Enclosing class:

LocalizableStringResolver

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

The localizable string resolver for task related text.

Method Summary

Modifier and Type	Method and Description
TaskActionDetailsList	getActionDetailsForTask(TaskKey taskKey) Returns the task action details for all of the task actions associated with a task.
TaskActionDetailsList	getActionDetailsForTask(TaskWDOSnapshotDetails taskWDOSnapshotDetails) Returns the task action details for all of the task actions associated with a task.
java.lang.String	getActivityNameForTask(TaskKey taskKey) Returns the name of an activity associated with a specified task for the current locale of the user.
java.lang.String	getSubjectForTask(TaskKey taskKey) Returns the subject string for the specified task based on the current locale of the user.
java.lang.String	getSubjectForTask(TaskWDOSnapshotDetails taskWDOSnapshotDetails) Returns the subject string for the specified task based on the current locale of the user.
TaskSubjectList	getSubjectsForTasks(TaskKeyList taskKeyList) Returns the subject strings for the specified tasks based on the current locale of the user.
TaskSubjectList	getSubjectsForTasks(TaskWDOSnapshotDetailsList taskWDOSnapshotDetailsList) Returns the subject strings for the specified tasks based on the current locale of the user.

Method Detail

getSubjectsForTasks

TaskSubjectList getSubjectsForTasks(TaskKeyList taskKeyList)
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

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

Parameters:

taskKeyList - the list of identifiers for the Tasks whose subject text strings will be returned.

Returns:

the localized text strings for the subjects of the specified Tasks.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getSubjectsForTasks

TaskSubjectList getSubjectsForTasks(TaskWDOSnapshotDetailsList taskWDOSnapshotDetailsList)
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

Returns the subject strings for the specified tasks based on the current locale of the user. This method allows a WDO snapshot to be supplied if it has already been retrieved by the calling code. This avoids wasteful re-reading of this data.

Parameters:

taskWDOSnapshotDetailsList - the list of task wdo snapshot details.

Returns:

the localized text strings for the subjects of the specified Tasks.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getSubjectForTask

java.lang.String getSubjectForTask(TaskKey taskKey)
                            throws curam.util.exception.AppException,
                                   curam.util.exception.InformationalException

Returns the subject string for the specified task based on the current locale of the user.

Parameters:

taskKey - The key containing the identifier of the task whose subject text is resolved and returned.

Returns:

the fully resolved subject text string for the specified task.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getSubjectForTask

java.lang.String getSubjectForTask(TaskWDOSnapshotDetails taskWDOSnapshotDetails)
                            throws curam.util.exception.AppException,
                                   curam.util.exception.InformationalException

Returns the subject string for the specified task based on the current locale of the user. This method allows a WDO snapshot to be supplied if it has already been retrieved by the calling code. This avoids wasteful re-reading of this data.

Parameters:

taskWDOSnapshotDetails - A struct containing the identifier of the task whose subject text is resolved and returned and the WDO snapshot to use to replace the message place holders.

Returns:

the fully resolved subject text string for the specified task.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getActionDetailsForTask

TaskActionDetailsList getActionDetailsForTask(TaskKey taskKey)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Returns the task action details for all of the task actions associated with a task.

Parameters:

taskKey - the key of the task whose action messages will be returned.

Returns:

the task actions details for the specified task actions.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getActionDetailsForTask

TaskActionDetailsList getActionDetailsForTask(TaskWDOSnapshotDetails taskWDOSnapshotDetails)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Returns the task action details for all of the task actions associated with a task. This method allows a WDO snapshot to be supplied if it has already been retrieved by the calling code. This avoids wasteful re-reading of this data.

Parameters:

taskWDOSnapshotDetails - A struct containing the identifier of the task whose subject text is resolved and returned and the WDO snapshot to use to replace the message place holders.

Returns:

the task actions details for the specified task actions.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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

getActivityNameForTask

java.lang.String getActivityNameForTask(TaskKey taskKey)
                                 throws curam.util.exception.AppException,
                                        curam.util.exception.InformationalException

Returns the name of an activity associated with a specified task for the current locale of the user.

Parameters:

taskKey - the task identifier whose associated activity name text string will be returned.

Returns:

the localized text string for the name of the activity associated with the specified Task.

Throws:

curam.util.exception.AppException - Typical database exceptions.

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