ibi.broker.api.data.schedule
Class StorageLibraryEmail

java.lang.Object
  ibi.broker.api.data.schedule.StorageLibraryEmail

All Implemented Interfaces:

java.io.Serializable

public class StorageLibraryEmail
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

StorageLibraryEmail()

Method Summary

java.lang.String	getLibraryURL() Obtains the base URL contained in a library email notification.
java.lang.String	getMailFrom() Obtains the "From" email address in this Library email notification.
java.lang.String	getMailMessage() Obtains the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
java.lang.String	getMailReplyAddress() Obtains the "Reply" email address sent in this Library email notification.
java.lang.String	getMailServerName() Obtains the mail server name used to send this library email notification.
java.lang.String	getMailSubject() Obtains the email subject sent in this library email notification.
boolean	isSendEmailAfterSaveReport() Obtains the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library.
void	setLibraryURL(java.lang.String libraryURL) Assigns the base URL contained in a library email notification.
void	setMailFrom(java.lang.String mailFrom) Assigns the "From" email address in this Library email notification (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
void	setMailMessage(java.lang.String mailMessage) Assigns the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()).
void	setMailReplyAddress(java.lang.String mailReplyAddress) Assigns the "Reply" email address sent in this Library email notification.
void	setMailServerName(java.lang.String mailServerName) Assigns the mail server name used to send this library email notification.
void	setMailSubject(java.lang.String mailSubject) Assigns the email subject sent in this library email notification.
void	setSendEmailAfterSaveReport(boolean sendEmailAfterSaveReport) Assigns the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageLibraryEmail

public StorageLibraryEmail()

Method Detail

getMailFrom

public java.lang.String getMailFrom()

Obtains the "From" email address in this Library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "From" email address is 65 characters.

Returns:

Returns the "From" portion of the Library email notification as a String.

See Also:

setMailFrom(String), isSendEmailAfterSaveReport()

setMailFrom

public void setMailFrom(java.lang.String mailFrom)

Assigns the "From" email address in this Library email notification (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "From" email address is 65 characters.

Parameters:

mailFrom - The "From" portion of the Library email notification as a String.

See Also:

getMailFrom(), isSendEmailAfterSaveReport()

getMailMessage

public java.lang.String getMailMessage()

Obtains the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the email message is 255 characters.

Returns:

Returns the email message content as a String.

See Also:

setMailMessage(String), isSendEmailAfterSaveReport()

setMailMessage

public void setMailMessage(java.lang.String mailMessage)

Assigns the email message content contained in the email message sent out as part of this notification email (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the email message is 255 characters.

Parameters:

mailMessage - The email message content as a String.

See Also:

getMailMessage(), isSendEmailAfterSaveReport()

getMailReplyAddress

public java.lang.String getMailReplyAddress()

Obtains the "Reply" email address sent in this Library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "Reply" email address is 65 characters.

Returns:

Returns the email "Reply" address as a String.

See Also:

setMailReplyAddress(String), isSendEmailAfterSaveReport()

setMailReplyAddress

public void setMailReplyAddress(java.lang.String mailReplyAddress)

Assigns the "Reply" email address sent in this Library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "Reply" email address is 65 characters.

Parameters:

mailReplyAddress - The email "Reply" address as a String.

See Also:

getMailReplyAddress(), isSendEmailAfterSaveReport()

getMailServerName

public java.lang.String getMailServerName()

Obtains the mail server name used to send this library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the mail server name is 65 characters.

Returns:

The Mail Server Name as a String.

See Also:

setMailServerName(String), isSendEmailAfterSaveReport()

setMailServerName

public void setMailServerName(java.lang.String mailServerName)

Assigns the mail server name used to send this library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the mail server name is 65 characters.

Parameters:

mailServerName - The mail Server name as a String.

See Also:

getMailServerName(), isSendEmailAfterSaveReport()

getMailSubject

public java.lang.String getMailSubject()

Obtains the email subject sent in this library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "Subject" email header is 255 characters.

Returns:

The email "Subject" as a String.

See Also:

setMailSubject(String)

setMailSubject

public void setMailSubject(java.lang.String mailSubject)

Assigns the email subject sent in this library email notification. (Library email notification must be turned on by way of the setSendEmailAfterSaveReport()). The maximum size of the "Subject" email header is 255 characters.

Parameters:

mailSubject - The email "Subject" as a String.

See Also:

getMailSubject(), isSendEmailAfterSaveReport()

isSendEmailAfterSaveReport

public boolean isSendEmailAfterSaveReport()

Obtains the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library. If TRUE, an email notification is sent to users who have access to the report. If FALSE, no email notification is sent. The default is false.

Returns:

The boolean value of the sendEmailAfterSaveReport flag.

See Also:

setSendEmailAfterSaveReport(boolean)

setSendEmailAfterSaveReport

public void setSendEmailAfterSaveReport(boolean sendEmailAfterSaveReport)

Assigns the value of the boolean flag that specifies whether or not an email notification is sent after a report is saved to the library. If TRUE, an email notification is sent to users who have access to the report. If FALSE, no email notification is sent. The default is false.

Parameters:

sendEmailAfterSaveReport - The sendEmailAfterSaveReport flag as a boolean.

See Also:

isSendEmailAfterSaveReport()

getLibraryURL

public java.lang.String getLibraryURL()

Obtains the base URL contained in a library email notification. When library notification is turned on via setSendEmailAfterSaveReport(), all users who have access to a library report are sent an email that contains message content, usually a notification that the report is available, and a URL that opens the report in the browser. The base URL can be set to a value that is accessible inside or outside of the ReportCaster environment. Unless this is set, the default will be taken from the value in dserver.xmls. Returns a maximum of 128 characters.

Returns:

The library URL as a String.

See Also:

setLibraryURL(String), isSendEmailAfterSaveReport()

setLibraryURL

public void setLibraryURL(java.lang.String libraryURL)

Assigns the base URL contained in a library email notification. When library notification is turned on via setSendEmailAfterSaveReport(), all users who have access to a library report are sent an email that contains message content, usually a notification that the report is available, and a URL that opens the report in the browser. The base URL can be set to a value that is accessible inside or outside of the ReportCaster environment. Unless this is set, the default will be taken from the value in dserver.xmls. Accepts a maximum of 128 characters.

Parameters:

libraryURL - The library URL as a String.

See Also:

getLibraryURL(), isSendEmailAfterSaveReport()