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

Deprecated. use IPublicationDocumentProfileTarget instead

public interface IPublicationProfileTarget

This interface defines a publication profile target. Each publication contains a collection of publication profile targets.

A publication profile target is associated with a profile and a Desktop Intelligence document. When the publication is scheduled, the profile values are mapped to the variables and elements inside the associated Desktop Intelligence document.

Note: Always add profile associations and Desktop Intelligence document associations before you add the corresponding profile target.

Method Summary

int	getProfileID() Deprecated. use getVariableMappings() instead
int	getTargetID() Deprecated. use getSourceDocumentID() instead
java.lang.String	getVariable() Deprecated. use getVariableMappings() instead
void	setProfileID(int id) Deprecated. use getVariableMappings() instead
void	setTargetID(int id) Deprecated. use setSourceDocumentID(int) instead
void	setVariable(java.lang.String variable) Deprecated. use getVariableMappings() instead

Method Detail

getProfileID

int getProfileID()

Deprecated. use getVariableMappings() instead

Gets the profile ID associated with this publication profile target.

Returns:

An int that indicates the profile ID associated with this publication profile target.

setProfileID

void setProfileID(int id)
                  throws SDKException

Deprecated. use getVariableMappings() instead

Sets the profile ID associated with this publication profile target.

Note: Always add profile associations and Desktop Intelligence document associations before you add the corresponding profile target.

Parameters:

id - An int that indicates the profile ID associated with this publication profile target.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getTargetID

int getTargetID()

Deprecated. use getSourceDocumentID() instead

Gets the target Desktop Intelligence document ID associated with this publication profile target.

Returns:

An int that indicates the target Desktop Intelligence document ID associated with this publication profile target.

setTargetID

void setTargetID(int id)
                 throws SDKException

Deprecated. use setSourceDocumentID(int) instead

Sets the target Desktop Intelligence document ID associated with this publication profile target.

Note: Always add profile associations and Desktop Intelligence document associations before you add the corresponding profile target.

Parameters:

id - An int that indicates the target Desktop Intelligence document ID associated with this publication profile target.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getVariable

java.lang.String getVariable()

Deprecated. use getVariableMappings() instead

Gets the Desktop Intelligence document variable that the profile is applied to.

Note: The variable is an element within the document. It is assumed that you are familiar with the contents of the document.

Returns:

A String that indicates the Desktop Intelligence document variable that the profile is applied to.

setVariable

void setVariable(java.lang.String variable)
                 throws SDKException

Deprecated. use getVariableMappings() instead

Sets the Desktop Intelligence document variable that the profile is applied to.

Note: The variable is an element within the document. It is assumed that you are familiar with the contents of the document.

Parameters:

variable - A String that indicates the Desktop Intelligence document variable that the profile is applied to.

Throws:

SDKException - This is thrown if the process is unsuccessful.