Package com.uc4.api.objects

Class NotificationSettings

java.lang.Object

com.uc4.api.objects.NotificationSettings

public class NotificationSettings
extends Object

This class represents the "Notification" tab within a Notification object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NotificationSettings.ReportSource	Report source.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NotificationSettings(com.uc4.util.XMLDocument doc)	Creates a NotificationSettings using the specified XMLDocument

Method Summary

Modifier and Type	Method	Description
String	getAttachFile()
String	getAttachReportsFrom()
String	getMessage()	Returns the message of this Notification.
NotificationSettings.ReportSource	getSource()
String	getSubject()
void	setAttachFile(String attachFile)	Sets the file attachment.
void	setAttachReportsFrom(String attachReportsFrom)	Sets email attachments.
void	setMessage(String message)	Sets the text message for the Notification.
void	setSource(NotificationSettings.ReportSource source)	Sets the source of the files which should be attached to the mail.
void	setSubject(String subject)	Sets the subject text for the mail.
protected void	store(com.uc4.util.XMLDocument doc, Element request)	Stores the all parameters of this tab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotificationSettings

protected NotificationSettings(com.uc4.util.XMLDocument doc)

Creates a NotificationSettings using the specified XMLDocument

Parameters:

doc - XML document

Method Details

store

protected void store(com.uc4.util.XMLDocument doc,
 Element request)

Stores the all parameters of this tab

Parameters:

doc - XML Document

request - Parent Element

getSource

public NotificationSettings.ReportSource getSource()

Returns:

Source of the files which should be attached to the mail.

setSource

public void setSource(NotificationSettings.ReportSource source)

Sets the source of the files which should be attached to the mail.

Parameters:

source - Source of the Report files

setMessage

public void setMessage(String message)

Sets the text message for the Notification.

Parameters:

message - Message

getAttachReportsFrom

public String getAttachReportsFrom()

Returns:

Attach Reports from

setAttachReportsFrom

public void setAttachReportsFrom(String attachReportsFrom)

Sets email attachments.

Parameters:

attachReportsFrom - Max. 32 characters

getAttachFile

public String getAttachFile()

Returns:

File attachment

setAttachFile

public void setAttachFile(String attachFile)

Sets the file attachment.

Parameters:

attachFile - File name, Max 1024 characters

getSubject

public String getSubject()

Returns:

Subject text

setSubject

public void setSubject(String subject)

Sets the subject text for the mail.

Parameters:

subject - Subject

getMessage

public String getMessage()

Returns the message of this Notification.

Returns:

Message