Package com.microstrategy.web.objects

Interface WebSubscriptionDeliveryModeFTPProperties

All Superinterfaces:

EnumWebPersistableState, EnumWebSubscriptionDeliveryMode, Persistable, WebSubscriptionDeliveryModeProperties

public interface WebSubscriptionDeliveryModeFTPProperties
extends WebSubscriptionDeliveryModeProperties

Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant WebSubscriptionDeliveryModeProperties sub-interface.

This sub-interface is specifically for ftp deliveries

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Fields inherited from interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode

SUBSCRIPTION_DELIVERY_MODE_EMAIL, SUBSCRIPTION_DELIVERY_MODE_FILE, SUBSCRIPTION_DELIVERY_MODE_INBOX, SUBSCRIPTION_DELIVERY_MODE_PRINT

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFileName()	Retrieves the name of the file that is set using setFileName(String)
java.lang.String	getSpaceDelimiter()	Returns the space delimiter
java.lang.String	getZipFileName()	Sets the name of the compressed file associated with this subscription
java.lang.String	getZipFilePassword()	Returns the password of the compressed file.
boolean	isCompressed()	Returns whether the content that is delivered is compressed or not
boolean	isZipFileProtected()	Returns whether the compressed file is password protected
void	setCompression(boolean isCompressed)	Sets whether the content that is delivered is compressed or not
void	setFileName(java.lang.String name)	Sets the name of the file that should be created when this subscription gets triggered
void	setProtectZipFile(boolean isProtected)	Sets whether the compressed file is password protected.
void	setSpaceDelimiter(java.lang.String spaceDelimiter)	Sets the space delimiter
void	setZipFileName(java.lang.String fileName)	Returns the name of the compressed file saved in the subscrription
void	setZipFilePassword(java.lang.String p)	Sets the password of the compressed file.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

clone, getContactSecurity, getExecutionFlags, getExpiration, getExpirationTimeZone, getMode, setContactSecurity, setExecutionFlags, setExpiration, setExpirationTimeZone

Method Detail

getFileName

java.lang.String getFileName()

Retrieves the name of the file that is set using setFileName(String)

Returns:

the file name

setFileName

void setFileName(java.lang.String name)

Sets the name of the file that should be created when this subscription gets triggered

Parameters:

name - name of the file

isCompressed

boolean isCompressed()

Returns whether the content that is delivered is compressed or not

setCompression

void setCompression(boolean isCompressed)

Sets whether the content that is delivered is compressed or not

Parameters:

isCompressed -

setZipFilePassword

void setZipFilePassword(java.lang.String p)

Sets the password of the compressed file.

Parameters:

p -

getZipFileName

java.lang.String getZipFileName()

Sets the name of the compressed file associated with this subscription

Since:

MicroStrategy Web 9.0.0

setZipFileName

void setZipFileName(java.lang.String fileName)

Returns the name of the compressed file saved in the subscrription

Parameters:

fileName -

getZipFilePassword

java.lang.String getZipFilePassword()

Returns the password of the compressed file.

setProtectZipFile

void setProtectZipFile(boolean isProtected)

Sets whether the compressed file is password protected.

Parameters:

isProtected -

isZipFileProtected

boolean isZipFileProtected()

Returns whether the compressed file is password protected

getSpaceDelimiter

java.lang.String getSpaceDelimiter()

Returns the space delimiter

setSpaceDelimiter

void setSpaceDelimiter(java.lang.String spaceDelimiter)

Sets the space delimiter