Package com.microstrategy.web.objects
Interface WebSubscriptionDeliveryModeFileProperties
-
- All Superinterfaces:
EnumWebPersistableState
,EnumWebSubscriptionDeliveryMode
,Persistable
,WebSubscriptionDeliveryModeProperties
public interface WebSubscriptionDeliveryModeFileProperties extends WebSubscriptionDeliveryModeProperties
Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant
This sub-interface is specifically for file deliveriesWebSubscriptionDeliveryModeProperties
sub-interface.- Since:
- MicroStrategy Web 7.5.1
-
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getBurstSubFolder()
Returns the burst sub folderjava.lang.String
getFileName()
Retrieves the name of the file that is set usingsetFileName(String)
java.lang.String
getSpaceDelimiter()
Returns the space delimiterjava.lang.String
getZipFileName()
Sets the name of the compressed file associated with this subscriptionjava.lang.String
getZipFilePassword()
Returns the password of the compressed file.boolean
isCompressed()
Returns whether the content that is delivered is compressed or notboolean
isZipFileProtected()
Returns whether the compressed file is password protectedvoid
setBurstSubFolder(java.lang.String burstSubFolder)
Sets the burst sub foldervoid
setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or notvoid
setFileName(java.lang.String name)
Sets the name of the file that should be created when this subscription gets triggeredvoid
setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.void
setSpaceDelimiter(java.lang.String spaceDelimiter)
Sets the space delimitervoid
setZipFileName(java.lang.String fileName)
Returns the name of the compressed file saved in the subscrriptionvoid
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, getMode, setContactSecurity, setExecutionFlags, setExpiration
-
-
-
-
Method Detail
-
getFileName
java.lang.String getFileName()
Retrieves the name of the file that is set usingsetFileName(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- Since:
- MicroStrategy Web 9.0.0
-
setCompression
void setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or not- Parameters:
isCompressed
-- Since:
- MicroStrategy Web 9.0.0
-
setZipFilePassword
void setZipFilePassword(java.lang.String p)
Sets the password of the compressed file.- Parameters:
p
-- Since:
- MicroStrategy Web 9.0.0
-
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
-- Since:
- MicroStrategy Web 9.0.0
-
getZipFilePassword
java.lang.String getZipFilePassword()
Returns the password of the compressed file.- Since:
- MicroStrategy Web 9.0.0
-
setProtectZipFile
void setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.- Parameters:
isProtected
-- Since:
- MicroStrategy Web 9.0.0
-
isZipFileProtected
boolean isZipFileProtected()
Returns whether the compressed file is password protected- Since:
- MicroStrategy Web 9.0.0
-
getSpaceDelimiter
java.lang.String getSpaceDelimiter()
Returns the space delimiter
-
setSpaceDelimiter
void setSpaceDelimiter(java.lang.String spaceDelimiter)
Sets the space delimiter
-
getBurstSubFolder
java.lang.String getBurstSubFolder()
Returns the burst sub folder- Since:
- MicroStrategy Web Polaris
-
setBurstSubFolder
void setBurstSubFolder(java.lang.String burstSubFolder)
Sets the burst sub folder- Since:
- MicroStrategy Web Polaris
-
-