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

public interface IPublicationEventHandlers

This interface represents a collection of IPublicationEventHandler objects.

Method Summary

IPublicationEventHandler	addPublicationEventHandler(java.lang.Integer eventNameID) Creates a publication event handler and adds it to the collection.
IPublicationEventHandler	getPublicationEventHandler(java.lang.Integer eventNameID) Returns the IPublicationEventHandler object for the specified event ID.
java.lang.String[]	getPublicationEventHandlersName() Returns the names of the publication event handlers in the collection.
void	removePublicationEventHandler(java.lang.Integer eventNameID) Remove the IPublicationEventHandler object for the specified event ID from collection.
void	setPublicationEventHandler(java.lang.Integer eventNameID, PublicationEventHandler src) Adds a PublicationEventHandler object to the collection.

Method Detail

getPublicationEventHandlersName

java.lang.String[] getPublicationEventHandlersName()
                                                   throws SDKException

Returns the names of the publication event handlers in the collection.

Returns:

An array containing the names of all registered event handlers.

Throws:

SDKException - Thrown if an error occurs.

addPublicationEventHandler

IPublicationEventHandler addPublicationEventHandler(java.lang.Integer eventNameID)
                                                    throws SDKException

Creates a publication event handler and adds it to the collection. The event ID specifies the type of event that will invoke the handler. It must be one of the following constants:

CePropertyID.SI_ON_READ_RECIPIENTS - Triggered when the publication reads the list of recipients

CePropertyID.SI_ON_POST_PROCESS_PERSONALIZED_DOCS - Triggered after all publication documents have been personalized

CePropertyID.SI_ON_AFTER_DELIVER_SCOPE_BATCH - Triggered after the publication has been delivered to all recipients

Note that only one event handler for each event type can be added to the collection. If you call this method more than once with the same event ID, the event handler that was previously set for that event ID is overwritten.

Parameters:

eventNameID - the ID of the event type

Returns:

The new IPublicationEventHandler object.

Throws:

SDKException

setPublicationEventHandler

void setPublicationEventHandler(java.lang.Integer eventNameID,
                                PublicationEventHandler src)
                                throws SDKException

Adds a PublicationEventHandler object to the collection. The event ID specifies the type of event that will invoke the handler. It must be one of the following constants:

CePropertyID.SI_ON_READ_RECIPIENTS - Triggered when the publication reads the list of recipients

CePropertyID.SI_ON_POST_PROCESS_PERSONALIZED_DOCS - Triggered after all publication documents have been personalized

CePropertyID.SI_ON_AFTER_DELIVER_SCOPE_BATCH - Triggered after the publication has been delivered to all recipients

Note that only one event handler for each event type can be added to the collection. If you call this method more than once with the same event ID, the event handler that was previously set for that event ID is overwritten.

Parameters:

eventNameID - the ID of the event type

src - The PublicationEventHandler object

Throws:

SDKException - Thrown if an error occurs.

getPublicationEventHandler

IPublicationEventHandler getPublicationEventHandler(java.lang.Integer eventNameID)

Returns the IPublicationEventHandler object for the specified event ID. The event ID specifies the type of event that will invoke the handler. It must be one of the following constants:

CePropertyID.SI_ON_READ_RECIPIENTS}- Triggered when the publication reads the list of recipients.

CePropertyID.SI_ON_POST_PROCESS_PERSONALIZED_DOCS - Triggered after all publication documents have been personalized.

CePropertyID.SI_ON_AFTER_DELIVER_SCOPE_BATCH - Triggered after the publication has been delivered to all recipients.

Parameters:

eventNameID - The ID of the event type

Returns:

A IPublicationEventHandler object.

removePublicationEventHandler

void removePublicationEventHandler(java.lang.Integer eventNameID)
                                   throws SDKException

Remove the IPublicationEventHandler object for the specified event ID from collection. The event ID specifies the type of event that will invoke the handler. It must be one of the following constants:

CePropertyID.SI_ON_READ_RECIPIENTS}- Triggered when the publication reads the list of recipients.

CePropertyID.SI_ON_POST_PROCESS_PERSONALIZED_DOCS - Triggered after all publication documents have been personalized.

CePropertyID.SI_ON_AFTER_DELIVER_SCOPE_BATCH - Triggered after the publication has been delivered to all recipients.

Parameters:

eventNameID - The ID of the event type

Throws:

SDKException - Thrown when there is a propertyBag operation exception.