com.businessobjects.publisher.postprocessing
Class PluginTargetDestination

java.lang.Object
  com.businessobjects.publisher.postprocessing.PluginTargetDestination

public class PluginTargetDestination
extends java.lang.Object

This class represents a BusinessObjects Enterprise destination that receives artifacts created by publications. It is used to enable the plugin for a default destination. To enable a post-processing plugin for a destination, add a configured PluginTargetDestination instance to the target destinations collection of the plugin.

See Also:

IPublicationPostProcessingPlugin.getTargetDestinations()

Constructor Summary

PluginTargetDestination()
The constructor.

PluginTargetDestination(java.lang.String destinationName, int distributionMode)
The constructor.

Method Summary

java.lang.String	getDestinationName() Returns the ProgID of the destination.
int	getDistributionMode() Returns the distribution mode for the destination.
void	setDistributionMode(int distributionMode) Sets the distribution mode for the destination.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginTargetDestination

public PluginTargetDestination()

The constructor.

PluginTargetDestination

public PluginTargetDestination(java.lang.String destinationName,
                               int distributionMode)
                        throws SDKException

The constructor.

Parameters:

destinationName - The ProgID of the destination.

distributionMode - The distribution mode. Must correspond to a value in IDestinationPluginArtifactFormat.CeDistributionMode.

Throws:

SDKException

Method Detail

setDistributionMode

public void setDistributionMode(int distributionMode)
                         throws SDKException

Sets the distribution mode for the destination. The distribution mode determines whether the source documents are distributed to recipients along with the other publication artifacts. Possible values are:

• IDestinationPluginArtifactFormat.CeDistributionMode.FILTER_NONE
• IDestinationPluginArtifactFormat.CeDistributionMode.FILTER_EXCLUDE_SOURCE_DOCUMENTS

Parameters:

distributionMode - The distribution mode. Must correspond to a value in IDestinationPluginArtifactFormat.CeDistributionMode.

Throws:

SDKException

getDestinationName

public java.lang.String getDestinationName()

Returns the ProgID of the destination.

Returns:

String containing the ProgID of the destination.

getDistributionMode

public int getDistributionMode()

Returns the distribution mode for the destination. The distribution mode determines whether the source documents are distributed to recipients along with the other publication artifacts. Possible values are:

• IDestinationPluginArtifactFormat.CeDistributionMode.FILTER_NONE
• IDestinationPluginArtifactFormat.CeDistributionMode.FILTER_EXCLUDE_SOURCE_DOCUMENTS

Parameters:

distributionMode - The distribution mode.

See Also:

IDestinationPluginArtifactFormat.CeDistributionMode