com.adobe.idp.taskmanager.dsc.client.emailsettings
Interface EmailSettingService

public interface EmailSettingService

Represents the current email notification settings -- the main interface in this package.

Method Summary

java.util.List	getAdminNotificationSettings() Returns the current notification settings.
EmailServerSettings	getServerSettings() Returns the Server email settings (SMTP, POP3, etc)
java.util.List	getTaskNotificationEncodings() Retrieves a list of the possible email encodings for task notifications
java.util.List	getTaskNotificationSettings() Retrieves the Task notification settings
EmailServerSettings	newEmailServerSettings() Gets a new instance of the EmailServerSettings VO
TaskNotificationMessage	newTaskNotificationMessage(NotificationType type) Gets a new instance of the TaskNotificationMessage VO
void	saveAdminNotificationSettings(java.util.List messages) Saves Administrative notification settings.
void	saveServerSettings(EmailServerSettings settings) Saves the Server email settings (SMTP, POP3, etc).
void	saveTaskNotificationSettings(java.util.List messages) Saves Task Notification settings.

Method Detail

getTaskNotificationSettings

java.util.List getTaskNotificationSettings()
                                           throws EmailSettingsException

Retrieves the Task notification settings

Returns:

Task Notification settings

Throws:

EmailSettingsException

saveTaskNotificationSettings

void saveTaskNotificationSettings(java.util.List messages)
                                  throws EmailSettingsException

Saves Task Notification settings. Only notifications provided in the input list are updated

Parameters:

messages - The list of messages to update, specifically of the "TaskNotificationType" enum

Throws:

EmailSettingsException

getTaskNotificationEncodings

java.util.List getTaskNotificationEncodings()
                                            throws EmailSettingsException

Retrieves a list of the possible email encodings for task notifications

Returns:

Task Notification email encodings

Throws:

EmailSettingsException

getAdminNotificationSettings

java.util.List getAdminNotificationSettings()
                                            throws EmailSettingsException

Returns the current notification settings.

Administrators configure the email notification settings by using the Configure Server Settings page in the LiveCycle Administration Console.

Returns:

List object containing the email notification settings

Throws:

EmailSettingsException

saveAdminNotificationSettings

void saveAdminNotificationSettings(java.util.List messages)
                                   throws EmailSettingsException

Saves Administrative notification settings. Only notifications provided in the input list are updated.

Parameters:

messages - a List of TaskNotificationMessages, specifically of the "AdministrativeNotificationType" enum

Throws:

EmailSettingsException

getServerSettings

EmailServerSettings getServerSettings()
                                      throws EmailSettingsException

Returns the Server email settings (SMTP, POP3, etc)

Returns:

the Email settings

Throws:

EmailSettingsException

saveServerSettings

void saveServerSettings(EmailServerSettings settings)
                        throws EmailSettingsException

Saves the Server email settings (SMTP, POP3, etc).

Parameters:

settings - the settings to save

Throws:

EmailSettingsException

newEmailServerSettings

EmailServerSettings newEmailServerSettings()

Gets a new instance of the EmailServerSettings VO

Returns:

newTaskNotificationMessage

TaskNotificationMessage newTaskNotificationMessage(NotificationType type)

Gets a new instance of the TaskNotificationMessage VO

Returns: