Package com.microstrategy.web.objects
Interface WebSubscriptionContentProperties
-
- All Known Subinterfaces:
WebSubscriptionContent,WebSubscriptionContentDocument,WebSubscriptionContentReport,WebSubscriptionContentReportProperties
public interface WebSubscriptionContentPropertiesThis interface helps define specific properties that control the formatting of the content- Since:
- MicroStrategy Web 7.5.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetContentType()Indicates the type of content.WebSubscriptionContentFormatgetFormat()intgetFormatMode()possible values are fromEnumWebSubscriptionContentFormatModesbooleanisFormatCompressed()Indicates whether the content that will be delivered should be compressedvoidsetCompressed(boolean compress)Indicates whether the content that will be delivered should be compressedvoidsetFormat(WebSubscriptionContentFormat format)If the format is not explicitly set, then format corresponding toEnumWebSubscriptionContentFormatTypes.SUBSCRIPTION_CONTENT_FORMAT_HTMLis assumedvoidsetFormatMode(int mode)Sets the mode of the content format
-
-
-
Method Detail
-
getFormat
WebSubscriptionContentFormat getFormat()
- Returns:
- the current format that is set
-
setFormat
void setFormat(WebSubscriptionContentFormat format)
If the format is not explicitly set, then format corresponding toEnumWebSubscriptionContentFormatTypes.SUBSCRIPTION_CONTENT_FORMAT_HTMLis assumed
-
isFormatCompressed
boolean isFormatCompressed()
Indicates whether the content that will be delivered should be compressed- Returns:
- boolean indicating whether the delivery will be compressed
-
setCompressed
void setCompressed(boolean compress)
Indicates whether the content that will be delivered should be compressed- Parameters:
compress- indicates whether the content delivered should be compressed
-
getContentType
int getContentType()
Indicates the type of content. This is a value fromEnumWebSubscriptionContentTypes- Returns:
- the type of content
-
getFormatMode
int getFormatMode()
possible values are fromEnumWebSubscriptionContentFormatModes- Since:
- MicroStrategy Web 8.0.0
-
setFormatMode
void setFormatMode(int mode)
Sets the mode of the content format- Parameters:
mode- possible values are fromEnumWebSubscriptionContentFormatModes- Since:
- MicroStrategy Web 8.0.0
-
-