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

public interface IPublicationEventHandlerInfo

This interface contains information about a publication event handler.

Method Summary

int	getDynamicDataDocumentID() Returns the ID of the report document that contains the dynamic recipients for the publication.
int	getDynamicDataDocumentInstanceID() Returns the ID of the report document instance that contains the dynamic recipients for the publication.
java.lang.String	getGenericParameter() Returns the value of the generic parameter.
IPublicationEventHandlerParams	getMethodParameters() Returns the parameters associated with the publication event method.
java.lang.String	getName() Returns the event name.
java.lang.String	getPluginClassName() Returns the plugin class name associated with the publication event.
IProperties	getProperties() For internal use only.
java.lang.String	getSourceName() Returns the source name.
void	setDynamicDataDocumentID(int documentID) Sets the ID of the report document that contains the dynamic recipients for the publication.
void	setDynamicDataDocumentInstanceID(int instanceID) Sets the ID of the report document instance that contains the dynamic recipients for the publication.
void	setGenericParameter(java.lang.String parameterValue) Sets the value of the generic parameter.
void	setMethodParameters(IPublicationEventHandlerParams params) Sets the parameters associated with the publication event method.
void	setName(java.lang.String nameValue) Sets the event name.
void	setPluginClassName(java.lang.String value) Sets the plugin class name associated with the publication event.
void	setSourceName(java.lang.String sourceValue) Sets the source name.

Method Detail

getPluginClassName

java.lang.String getPluginClassName()

Returns the plugin class name associated with the publication event.

Returns:

The fully-qualified class name of the plugin.

See Also:

IPublicationEventHandlerInfo.setPluginClassName(java.lang.String)

setPluginClassName

void setPluginClassName(java.lang.String value)
                        throws SDKException

Sets the plugin class name associated with the publication event.

The following built-in plugin classes are supported for specifying dynamic recipients:

com.businessobjects.publisher.dynamicrecipients.crystalreports.CRDataProvider (Crystal Reports dynamic recipient provider)

com.businessobjects.publisher.dynamicrecipients.rebean.REDataProvider (Web Intelligence/Desktop Intelligence dynamic recipient provider)

The following built-in publishing extension classes are supported for post processing:

com.businessobjects.publisher.postprocessing.plugin.PdfMergePlugin (PDF merge)

com.businessobjects.publisher.postprocessing.plugin.ZipMergePlugin (Zip merge)

Parameters:

value - the fully-qualified class name of the plugin

Throws:

SDKException - if the process is unsuccessful.

getDynamicDataDocumentID

int getDynamicDataDocumentID()

Returns the ID of the report document that contains the dynamic recipients for the publication.

Returns:

The ID of the dynamic data document.

Throws:

SDKException - if the process is unsuccessful.

setDynamicDataDocumentID

void setDynamicDataDocumentID(int documentID)
                              throws SDKException

Sets the ID of the report document that contains the dynamic recipients for the publication.

Parameters:

documentID - dynamic data document ID

Throws:

SDKException - if the process is unsuccessful.

getDynamicDataDocumentInstanceID

int getDynamicDataDocumentInstanceID()

Returns the ID of the report document instance that contains the dynamic recipients for the publication.

Returns:

The ID of the dynamic data document instance.

setDynamicDataDocumentInstanceID

void setDynamicDataDocumentInstanceID(int instanceID)
                                      throws SDKException

Sets the ID of the report document instance that contains the dynamic recipients for the publication.

Parameters:

documentID - dynamic data document instance ID

Throws:

SDKException - if the process is unsuccessful.

getMethodParameters

IPublicationEventHandlerParams getMethodParameters()
                                                   throws SDKException

Returns the parameters associated with the publication event method.

Returns:

An IPublicationEventHandlerParams collection containing the parameters associated with the publication event method.

Throws:

SDKException - if the process is unsuccessful.

setMethodParameters

void setMethodParameters(IPublicationEventHandlerParams params)
                         throws SDKException

Sets the parameters associated with the publication event method.

Parameters:

params - the collection of parameters associated with the publication event method

Throws:

SDKException - if the process is unsuccessful.

getProperties

IProperties getProperties()
                          throws SDKException

For internal use only.

Throws:

SDKException

getName

java.lang.String getName()

Returns the event name.

Returns:

The event name.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IPublicationEventHandlerInfo.setName(java.lang.String)

setName

void setName(java.lang.String nameValue)
             throws SDKException

Sets the event name.

Possible values are:

• CePropertyID.SI_ON_READ_RECIPIENTS - to create an event handler that specifies a dynamic recipient provider
• CePropertyID.SI_ON_POST_PROCESS_PERSONALIZED_DOCS - to create an event handler that sets the publishing extension that runs after the publication is personalized and before it is delivered
• CePropertyID.SI_ON_AFTER_DELIVER_SCOPE_BATCH - to create an event handler that sets the publishing extension that runs after the publication is delivered

Parameters:

nameValue - the event name

Throws:

SDKException - if the process is unsuccessful.

getSourceName

java.lang.String getSourceName()

Returns the source name.

The source name is used when there is more than one data source in the document associated with the data provider. (Web Intelligence and Desktop Intelligence data providers can have multiple data source; Crystal Reports data providers cannot.)

Returns:

The source name.

Throws:

SDKException - if the process is unsuccessful.

setSourceName

void setSourceName(java.lang.String sourceValue)
                   throws SDKException

Sets the source name.

The source name is used when there is more than one data source in the document associated with the data provider. (Web Intelligence and Desktop Intelligence data providers can have multiple data source; Crystal Reports data providers cannot.)

Parameters:

sourceValue - the source name

Throws:

SDKException - if the process is unsuccessful.

getGenericParameter

java.lang.String getGenericParameter()

Returns the value of the generic parameter. This is only used by custom data providers.

Returns:

The generic parameter value.

Throws:

SDKException - if the process is unsuccessful.

setGenericParameter

void setGenericParameter(java.lang.String parameterValue)
                         throws SDKException

Sets the value of the generic parameter. This is only used by custom data providers.

Parameters:

parameterValue - the generic parameter value

Throws:

SDKException - if the process is unsuccessful.