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

public interface IPublicationEventHandlerParams

This interface defines the parameters (name/value pairs) for the publication event handler.

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) Add a parameter to the collection.
java.lang.String[]	getParametersName() Returns the names of the parameters to the publication event handler.
java.lang.String	getParameterValue(java.lang.String name) Returns the value of the specified parameter.
IProperties	getProperties() Returns the collection of parameters as an IProperties object.
void	removeParameter(java.lang.String name) Removes the specified parameter.
void	setParameterValue(java.lang.String name, java.lang.String value) Sets the value of the specified parameter.

Method Detail

getParametersName

java.lang.String[] getParametersName()

Returns the names of the parameters to the publication event handler.

Returns:

An array containing the parameter names.

addParameter

void addParameter(java.lang.String name,
                  java.lang.String value)
                  throws SDKException

Add a parameter to the collection.

Parameters:

name - the name of the parameter

value - the value of the parameter

Throws:

SDKException

getParameterValue

java.lang.String getParameterValue(java.lang.String name)

Returns the value of the specified parameter.

Parameters:

name - the name of the parameter

Returns:

The parameter value.

setParameterValue

void setParameterValue(java.lang.String name,
                       java.lang.String value)
                       throws SDKException

Sets the value of the specified parameter.

Parameters:

name - the name of the parameter

value - the value of the parameter

Throws:

SDKException

removeParameter

void removeParameter(java.lang.String name)
                     throws SDKException

Removes the specified parameter.

Parameters:

name - the name of the parameter

Throws:

SDKException

getProperties

IProperties getProperties()

Returns the collection of parameters as an IProperties object.

Returns:

An IProperties object containing the collection of parameters.

Throws:

SDKException