com.crystaldecisions.sdk.plugin.desktop.common
Interface IPublicationDocumentVariableMapping

All Superinterfaces:

IPersonalizationVariableMapping

public interface IPublicationDocumentVariableMapping
extends IPersonalizationVariableMapping

Method Summary

java.lang.String	getMultilingualUniverseCUID() For profile targets that are multilingual universes, retrieves the CUID that uniquely identifies the universe.
java.lang.String	getMultilingualVariableID() For profile targets that are multilingual universes, sets the ID that uniquely identifies the variable in the universe.
int	getProfileID() Returns the profile ID.
java.lang.String	getSubreportName() Returns the subreport name.
java.lang.String	getVariableName() Returns variable name.
void	setMultilingualUniverseCUID(java.lang.String identifier) For profile targets that are part of multilingual universes, sets the CUID that uniquely identifies the universe.
void	setMultilingualVariableID(java.lang.String variableID) For profile targets that are part of multilingual universes, sets the ID that uniquely identifies the variable in the universe.
void	setProfileID(int profileID) Sets the profile ID.
void	setSubreportName(java.lang.String subreportName) Sets the subreport name.
void	setVariableName(java.lang.String variableName) Sets the variable name.

Method Detail

setVariableName

void setVariableName(java.lang.String variableName)
                     throws SDKException

Sets the variable name.

Parameters:

variableName - A String containing the variable name

Throws:

SDKException

getVariableName

java.lang.String getVariableName()

Returns variable name.

Specified by:

getVariableName in interface IPersonalizationVariableMapping

Returns:

The variable name.

setSubreportName

void setSubreportName(java.lang.String subreportName)
                      throws SDKException

Sets the subreport name.

Parameters:

subreportName - A String containing the name of the subreport that contains the specified variable.

Throws:

SDKException

getSubreportName

java.lang.String getSubreportName()

Returns the subreport name.

Specified by:

getSubreportName in interface IPersonalizationVariableMapping

Returns:

The name of the subreport that contains the specified variable.

setMultilingualUniverseCUID

void setMultilingualUniverseCUID(java.lang.String identifier)

For profile targets that are part of multilingual universes, sets the CUID that uniquely identifies the universe. Even if this value is set, setTargetID(), setUniverseClass(), and setVariable() should be called for use by documents that do not support multilingual universes.

Parameters:

identifier - a String representing the CUID of the multilingual universe target.

getMultilingualUniverseCUID

java.lang.String getMultilingualUniverseCUID()

For profile targets that are multilingual universes, retrieves the CUID that uniquely identifies the universe.

Returns:

A String representing the CUID of the multilingual universe target.

setMultilingualVariableID

void setMultilingualVariableID(java.lang.String variableID)

For profile targets that are part of multilingual universes, sets the ID that uniquely identifies the variable in the universe. Even if this value is set, setTargetID(), setUniverseClass(), and setVariable() should be called for use by documents that do not support multilingual universes.

Parameters:

variableID - A String representing the ID of the target in the multilingual universe.

getMultilingualVariableID

java.lang.String getMultilingualVariableID()

For profile targets that are multilingual universes, sets the ID that uniquely identifies the variable in the universe.

Specified by:

getMultilingualVariableID in interface IPersonalizationVariableMapping

Returns:

A String representing the ID of the target in a multilingual universe.

setProfileID

void setProfileID(int profileID)
                  throws SDKException

Sets the profile ID.

Parameters:

profileID - the profile ID

Throws:

SDKException

getProfileID

int getProfileID()

Returns the profile ID.

Returns:

the profile ID.