public interface

EnumWebSubscriptionContentFormatModes

com.microstrategy.web.objects.EnumWebSubscriptionContentFormatModes

Class Overview

This interface specifies constants that define how much of the Report services document, which has group by units, should be delivered.

Summary

Constants
int FORMAT_MODE_DELIVERY_ALL_PAGES This indicates that the entire document should be delivered.
int FORMAT_MODE_DELIVERY_ALL_PAGES_SEPARATED Separates each page-by section when expanding all pages.
int FORMAT_MODE_DELIVERY_CURRENT_LAYOUT This applies only to RW documents.
int FORMAT_MODE_DELIVERY_CURRENT_PAGE This indicates that only the current subset of data should be delivered.
int FORMAT_MODE_DELIVERY_CURRENT_WINDOW This applies only to RW documents.
int FORMAT_MODE_DELIVERY_DEFAULT This indicates that the setting in the document definition should be honored.

Constants

public static final int FORMAT_MODE_DELIVERY_ALL_PAGES

This indicates that the entire document should be delivered.

Constant Value: 3 (0x00000003)

public static final int FORMAT_MODE_DELIVERY_ALL_PAGES_SEPARATED

Separates each page-by section when expanding all pages. Currently only applicable to SUBSCRIPTION_CONTENT_FORMAT_EXCEL, where each page-by is alloted its own worksheet.

Constant Value: 4 (0x00000004)

public static final int FORMAT_MODE_DELIVERY_CURRENT_LAYOUT

This applies only to RW documents. It indicates that the current layout for all group by selections will be delivered

Constant Value: 6 (0x00000006)

public static final int FORMAT_MODE_DELIVERY_CURRENT_PAGE

This indicates that only the current subset of data should be delivered.

Constant Value: 2 (0x00000002)

public static final int FORMAT_MODE_DELIVERY_CURRENT_WINDOW

This applies only to RW documents. It indicates that all the layouts for the current group by will be delivered

Constant Value: 5 (0x00000005)

public static final int FORMAT_MODE_DELIVERY_DEFAULT

This indicates that the setting in the document definition should be honored.

Constant Value: 1 (0x00000001)