com.businessobjects.publisher.postprocessing
Interface IPublicationPostProcessingPlugin

public interface IPublicationPostProcessingPlugin

This interface must be implemented by post-processing publication extensions. It is used to customize the behavior of the publishing engine after the publication has been personalized and before it is delivered to the recipients.

Method Summary

java.util.Collection	getTargetDestinations() Returns the collection of destinations to which artifacts from this plugin are sent (if those destinations are enabled for the publication).
IInfoObjects	handle(IPublicationPostProcessingContext context) This method is invoked after the publishing engine has finished personalizing the publication for a particular destination and scope.

Method Detail

handle

IInfoObjects handle(IPublicationPostProcessingContext context)
                    throws java.lang.Exception

This method is invoked after the publishing engine has finished personalizing the publication for a particular destination and scope. It must return an IInfoObjects collection containing all the artifacts created by the plugin that will be delivered to the recipients associated with the current destination and scope.

Parameters:

context - An object containing contextual information, including the current session, the scope, and the destination.

Returns:

IInfoObjects collection containing the artifacts generated by this plugin.

Throws:

java.lang.Exception - This is thrown if the operation does not complete successfully.

getTargetDestinations

java.util.Collection getTargetDestinations()
                                           throws java.lang.Exception

Returns the collection of destinations to which artifacts from this plugin are sent (if those destinations are enabled for the publication). All supported destinations must be added to the collection. If this method returns null or the collection is empty, then the target destinations must be configured using either IPublicationBase.getDefaultDestinationPluginArtifactFormats() or IDestination.getDestinationPluginArtifactFormats().

Returns:

Collection containing the PluginTargetDestination objects.

Throws:

java.lang.Exception - This is thrown if the operation does not complete successfully.