com.businessobjects.sdk.plugin.desktop.publication
Interface IPublishablePluginOptions

public interface IPublishablePluginOptions

Method Summary

IPluginBurstingModeOptions	getBurstingModeOptions(long burstingMode) Gets the busting mode options for the given busting mode, options determine whether bursting mode is supported for this plugin kind, whether the scope batch size is limited and whether dynamice recipients are allowed by this bursting mode
java.lang.String	getFormatDefinitionClass() Determines the format definition class for the plugin kind
java.lang.String	getLocalizedFormatName(java.lang.String formatName, java.util.Locale locale) Determines the localized format name for a given format
boolean	isDocumentDeliveryRuleEnabled() Determines whether the plugin kind supports document delivery rule
boolean	isGlobalDeliveryRuleEnabled() Determines whether the plugin kind supports global delivery rule
boolean	isLocaleDeliveryRuleEnabled() Determines whether the plugin kind supports locale delivery rule
boolean	isMHTMLMergeEnabled() Determines whether the plugin kind supports MHTML merging
boolean	isPDFMergeEnabled() Determines whether the plugin kind supports pdf merging
boolean	isPersonalizationEnabled() Determines whether the plugin kind supports personalization
boolean	isProfileResolutionEnabled() Determines whether the plugin kind supports profile resolution

Method Detail

isPDFMergeEnabled

boolean isPDFMergeEnabled()

Determines whether the plugin kind supports pdf merging

Returns:

true if supported, false otherwise

isMHTMLMergeEnabled

boolean isMHTMLMergeEnabled()

Determines whether the plugin kind supports MHTML merging

Returns:

true if supported, false otherwise

isProfileResolutionEnabled

boolean isProfileResolutionEnabled()

Determines whether the plugin kind supports profile resolution

Returns:

true if supported, false otherwise

isPersonalizationEnabled

boolean isPersonalizationEnabled()

Determines whether the plugin kind supports personalization

Returns:

true if supported, false otherwise

isLocaleDeliveryRuleEnabled

boolean isLocaleDeliveryRuleEnabled()

Determines whether the plugin kind supports locale delivery rule

Returns:

true if supported, false otherwise

isDocumentDeliveryRuleEnabled

boolean isDocumentDeliveryRuleEnabled()

Determines whether the plugin kind supports document delivery rule

Returns:

true if supported, false otherwise

isGlobalDeliveryRuleEnabled

boolean isGlobalDeliveryRuleEnabled()

Determines whether the plugin kind supports global delivery rule

Returns:

true if supported, false otherwise

getBurstingModeOptions

IPluginBurstingModeOptions getBurstingModeOptions(long burstingMode)

Gets the busting mode options for the given busting mode, options determine whether bursting mode is supported for this plugin kind, whether the scope batch size is limited and whether dynamice recipients are allowed by this bursting mode

Parameters:

burstingMode - - DataBurstingMode. The value corresponds to a constant defined in IPublicationBase.CeDataBurstingMode.

Returns:

object to retrieve the options of the bursting mode

getFormatDefinitionClass

java.lang.String getFormatDefinitionClass()

Determines the format definition class for the plugin kind

Returns:

format definition class for the plugin kind

getLocalizedFormatName

java.lang.String getLocalizedFormatName(java.lang.String formatName,
                                        java.util.Locale locale)

Determines the localized format name for a given format

Parameters:

formatName - Name name of the format

locale - locale of the translated string

Returns:

localized format name for a given format or null if format does not exist