ibi.broker.api.data.schedule
Class StorageLibrary

java.lang.Object
  ibi.broker.api.data.schedule.Distribution
      ibi.broker.api.data.schedule.StorageLibrary

All Implemented Interfaces:

java.io.Serializable

public class StorageLibrary
extends Distribution

See Also:

Serialized Form

Field Summary

Fields inherited from class ibi.broker.api.data.schedule.Distribution

description, EMAIL, enabled, FTP, id, LIBRARY, MRE, PRINT, SFTP

Constructor Summary

StorageLibrary()

Method Summary

java.lang.String	getAccessList() Obtains the name of the access list associated with this report distribution to the library.
java.lang.String	getAccessType() Obtains the String constant representing the access type for this library distribution.
java.lang.String	getCategory() Obtains the library category associated with this report.
int	getExpirationData() Obtains the expiration data used to calculate the expiration of a Library resident report.
java.lang.String	getExpirationMode() Obtains the expiration mode as a String constant.
java.lang.String	getLibraryURL() Deprecated.
java.lang.String	getMailFrom() Deprecated.
java.lang.String	getMailMessage() Deprecated.
java.lang.String	getMailReplyAddress() Deprecated.
java.lang.String	getMailServerName() Deprecated.
java.lang.String	getMailSubject() Deprecated.
StorageLibraryEmail	getStorageLibraryEmail()
boolean	isSaveBurstFromList() Obtains the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List.
boolean	isSendEmailAfterSaveReport() Deprecated.
void	setAccessList(java.lang.String accessList) Assigns the name of the access list associated with this report distribution to the library.
void	setAccessType(java.lang.String accessType) Assigns the String constant representing the access type for this library distribution.
void	setCategory(java.lang.String category) Assigns the library category associated with this report.
void	setExpirationData(int expirationData) Assigns the expiration data used to calculate the expiration of a Library resident report.
void	setExpirationMode(java.lang.String expirationMode) Assigns the expiration mode as a String constant.
void	setLibraryURL(java.lang.String libraryURL) Deprecated.
void	setMailFrom(java.lang.String mailFrom) Deprecated.
void	setMailMessage(java.lang.String mailMessage) Deprecated.
void	setMailReplyAddress(java.lang.String mailReplyAddress) Deprecated.
void	setMailServerName(java.lang.String mailServerName) Deprecated.
void	setMailSubject(java.lang.String mailSubject) Deprecated.
void	setSaveBurstFromList(boolean b) Asigns the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List.
void	setSendEmailAfterSaveReport(boolean sendEmailAfterSaveReport) Deprecated.
void	setStorageLibraryEmail(StorageLibraryEmail storageLibraryEmail)

Methods inherited from class ibi.broker.api.data.schedule.Distribution

getDescription, getId, isEnabled, setDescription, setEnabled, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageLibrary

public StorageLibrary()

Method Detail

getAccessList

public java.lang.String getAccessList()

Obtains the name of the access list associated with this report distribution to the library. The access list is a collection of user IDs and burst values that specify whether a user can view a library resident report, or a burst segment of that report. Maximum length is 64 characters.

Returns:

The name of the access list as a String.

See Also:

setAccessList(String)

setAccessList

public void setAccessList(java.lang.String accessList)

Assigns the name of the access list associated with this report distribution to the library. The access list is a collection of user ids and burst values that specify whether a user can view a library resident report, or a burst segment of that report. Accepts a maximum of 64 characters.

Parameters:

accessList - The name of the access list as a String.

See Also:

getAccessList()

getAccessType

public java.lang.String getAccessType()

Obtains the String constant representing the access type for this library distribution. The access type is one of three options for viewing a library report: Content.ACCESS_TYPE_PUBLIC, Content.ACCESS_TYPE_OWNER, or Content.ACCESS_TYPE_LIST. The default is Content.ACCESS_TYPE_OWNER.

Returns:

The type of access as a String constant.

See Also:

Content.ACCESS_TYPE_OWNER, Content.ACCESS_TYPE_PUBLIC, Content.ACCESS_TYPE_LIST, getAccessType()

setAccessType

public void setAccessType(java.lang.String accessType)

Assigns the String constant representing the access type for this library distribution. The access type is one of three options for viewing a library report: Content.ACCESS_TYPE_PUBLIC, Content.ACCESS_TYPE_OWNER, or Content.ACCESS_TYPE_LIST The default is Content.ACCESS_TYPE_OWNER.

Parameters:

accessType - The type of access as a String constant.

See Also:

Content.ACCESS_TYPE_OWNER, Content.ACCESS_TYPE_PUBLIC, Content.ACCESS_TYPE_LIST, getAccessList()

getCategory

public java.lang.String getCategory()

Obtains the library category associated with this report. Each category is a root directory within the library used to organize the distribution of reports. Any task other than a Standard Report or MyReport that is delivered to the library must be assigned a category when a schedule is created. The scheduled report and all subsequent versions of the report are filed in subdirectories under the category assigned to it. If the category doesn't exist, a new category (i.e, root directory) is created upon distribution. The default is "default."

Returns:

The category name as a String.

See Also:

setCategory(String)

setCategory

public void setCategory(java.lang.String category)

Assigns the library category associated with this report. Each category is a root directory within the library used to organize the distribution of reports. Any task other than a Standard Report or MyReport that is delivered to the library must be assigned a category when a schedule is created. The scheduled report, and all subsequent versions of the report, are filed in subdirectories under the category assigned to it. If the category doesn't exist, a new category (i.e, root directory) is created upon distribution. Accepts a maximum of 90 characters. The default is "default".

Parameters:

category - The category name as a String.

See Also:

getCategory()

getExpirationData

public int getExpirationData()

Obtains the expiration data used to calculate the expiration of a Library resident report. For a given expiration mode, the expiration data represents a corresponding integer that, when combined with the expiration mode, determines if a report should expire. For example, if the expiration mode is set to Content.EXPIREMODE_DAY and the expiration data is set to 3, the report will expire in 3 days. For Content.EXPIREMODE_VERSION, the expiration data represents the threshold number of versions that must exist prior the report expiring from the library.

Returns:

Returns an integer that is associated with a corresponding expiration mode. Together they determine the length of time or number of versions before a report expires.

See Also:

setExpirationData(int), Content.EXPIREMODE_MONTH, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_DAY, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_VERSION, Content.EXPIREMODE_NEVER

setExpirationData

public void setExpirationData(int expirationData)

Assigns the expiration data used to calculate the expiration of a Library resident report. For a given expiration mode, the expiration data represents a corresponding integer that, when combined with the expiration mode, determines if a report should expire. For example, if the expiration mode is set to Content.EXPIREMODE_DAY and the expiration data is set to 3, the report will expire in 3 days. For Content.EXPIREMODE_VERSION, the expiration data represents the threshold number of versions that must exist prior the report expiring from the library.

Parameters:

expirationData - An integer that is associated with a corresponding expiration mode. Together they determine the length of time or number of versions before a report expires.

See Also:

getExpirationData(), Content.EXPIREMODE_MONTH, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_DAY, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_VERSION, Content.EXPIREMODE_NEVER

getExpirationMode

public java.lang.String getExpirationMode()

Obtains the expiration mode as a String constant. The expiration mode is a basis of calculating when a library report will expire. The expiration modes are: Content.EXPIREMODE_DAY, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_MONTH, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_NEVER, and Content.EXPIREMODE_VERSION. When associated with a corresponding expiration *data integer ReportCaster can determine when a library report will expire. For example, if the expiration mode is set to Content.EXPIREMODE_DAY and the expiration data is set to 3, the report will expire in 3 days. For expiration mode Content.EXPIREMODE_VERSION, the expiration data represents the threshold number of versions that must exist prior the report expiring from the library. The default is Content.EXPIREMODE_NEVER.

Returns:

The expiration mode as a String constant.

See Also:

setExpirationMode(String), Content.EXPIREMODE_MONTH, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_DAY, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_VERSION, Content.EXPIREMODE_NEVER

setExpirationMode

public void setExpirationMode(java.lang.String expirationMode)

Assigns the expiration mode as a String constant. The expiration mode is a basis of calculating when a library report will expire. The expiration modes are: Content.EXPIREMODE_DAY, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_MONTH, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_NEVER, and Content.EXPIREMODE_VERSION. When associated with a corresponding expiration *data integer ReportCaster can determine when a library report will expire. For example, if the expiration mode is set to Content.EXPIREMODE_DAY and the expiration data is set to 3, the report will expire in 3 days. For Content.EXPIREMODE_VERSION, the expiration data represents the threshold number of versions that must exist prior the report expiring from the library. The default is Content.EXPIREMODE_NEVER.

Parameters:

expirationMode - The expiration mode as a String constant.

See Also:

getExpirationMode(), Content.EXPIREMODE_MONTH, Content.EXPIREMODE_WEEK, Content.EXPIREMODE_DAY, Content.EXPIREMODE_YEAR, Content.EXPIREMODE_VERSION, Content.EXPIREMODE_NEVER

setSaveBurstFromList

public void setSaveBurstFromList(boolean b)

Asigns the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List. If YES, only library reports with burst value(s) defined in a specified Access List are stored in the Report Library. If NO, all scheduled library reports are stored in the Report Library.

Parameters:

b - The setSavedBurstFromList flag as a boolean.

See Also:

isSaveBurstFromList()

isSaveBurstFromList

public boolean isSaveBurstFromList()

Obtains the value of the boolean flag that specifies whether to store only library reports with burst value(s) defined in a specified Access List. If YES, only library reports with burst value(s) defined in a specified Access List are stored in the Report Library. If NO, all scheduled library reports are stored in the Report Library.

Returns:

The boolean value of the setSaveBurstFromList flag.

See Also:

setSaveBurstFromList(boolean)

getStorageLibraryEmail

public StorageLibraryEmail getStorageLibraryEmail()

setStorageLibraryEmail

public void setStorageLibraryEmail(StorageLibraryEmail storageLibraryEmail)

getMailFrom

public java.lang.String getMailFrom()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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()