public interface

WebSubscriptionContentProperties

com.microstrategy.web.objects.WebSubscriptionContentProperties
Known Indirect Subclasses

Class Overview

This interface helps define specific properties that control the formatting of the content

Summary

Public Methods
abstract int getContentType()
Indicates the type of content.
abstract WebSubscriptionContentFormat getFormat()
abstract int getFormatMode()
possible values are from EnumWebSubscriptionContentFormatModes
abstract boolean isFormatCompressed()
Indicates whether the content that will be delivered should be compressed
abstract void setCompressed(boolean compress)
Indicates whether the content that will be delivered should be compressed
abstract void setFormat(WebSubscriptionContentFormat format)
If the format is not explicitly set, then format corresponding to SUBSCRIPTION_CONTENT_FORMAT_HTML is assumed
abstract void setFormatMode(int mode)
Sets the mode of the content format

Public Methods

public abstract int getContentType ()

Indicates the type of content. This is a value from EnumWebSubscriptionContentTypes

Returns
  • the type of content

public abstract WebSubscriptionContentFormat getFormat ()

Returns
  • the current format that is set

public abstract int getFormatMode ()

possible values are from EnumWebSubscriptionContentFormatModes

public abstract boolean isFormatCompressed ()

Indicates whether the content that will be delivered should be compressed

Returns
  • boolean indicating whether the delivery will be compressed

public abstract 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

public abstract void setFormat (WebSubscriptionContentFormat format)

If the format is not explicitly set, then format corresponding to SUBSCRIPTION_CONTENT_FORMAT_HTML is assumed

public abstract void setFormatMode (int mode)

Sets the mode of the content format

Parameters
mode possible values are from EnumWebSubscriptionContentFormatModes