public interface

WebSubscriptionDeliveryModeFTPProperties

implements WebSubscriptionDeliveryModeProperties
com.microstrategy.web.objects.WebSubscriptionDeliveryModeFTPProperties

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
Public Methods
abstract String getFileName()
Retrieves the name of the file that is set using setFileName(String)
abstract String getSpaceDelimiter()
Returns the space delimiter
abstract String getZipFileName()
Sets the name of the compressed file associated with this subscription
abstract String getZipFilePassword()
Returns the password of the compressed file.
abstract boolean isCompressed()
Returns whether the content that is delivered is compressed or not
abstract boolean isZipFileProtected()
Returns whether the compressed file is password protected
abstract void setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or not
abstract void setFileName(String name)
Sets the name of the file that should be created when this subscription gets triggered
abstract void setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.
abstract void setSpaceDelimiter(String spaceDelimiter)
Sets the space delimiter
abstract void setZipFileName(String fileName)
Returns the name of the compressed file saved in the subscrription
abstract void setZipFilePassword(String pwd)
Sets the password of the compressed file.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

Public Methods

public abstract String getFileName ()

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

Returns
  • the file name

public abstract String getSpaceDelimiter ()

Returns the space delimiter

public abstract String getZipFileName ()

Sets the name of the compressed file associated with this subscription

public abstract String getZipFilePassword ()

Returns the password of the compressed file.

public abstract boolean isCompressed ()

Returns whether the content that is delivered is compressed or not

public abstract boolean isZipFileProtected ()

Returns whether the compressed file is password protected

public abstract void setCompression (boolean isCompressed)

Sets whether the content that is delivered is compressed or not

public abstract void setFileName (String name)

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

Parameters
name name of the file

public abstract void setProtectZipFile (boolean isProtected)

Sets whether the compressed file is password protected.

public abstract void setSpaceDelimiter (String spaceDelimiter)

Sets the space delimiter

public abstract void setZipFileName (String fileName)

Returns the name of the compressed file saved in the subscrription

public abstract void setZipFilePassword (String pwd)

Sets the password of the compressed file.