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

All Superinterfaces:

java.util.Collection, IPersonalizationVariableMappings, ISDKSet, java.lang.Iterable, java.util.Set

public interface IDynamicRecipientVariableMappings
extends ISDKSet, IPersonalizationVariableMappings

This interface is a collection used to create and store mappings between columns in a dynamic recipient provider document and variables, formulas, and fields in the document. During the personalization process, the profile values in these columns are compared to variables in the report document to determine which content is delivered to each recipient.

See Also:

IDynamicRecipientProviderColumns

Method Summary

IDynamicRecipientVariableMapping	addVariableMapping(int id, java.lang.String variableName, int providerColumnIndex) Creates a dynamic recipient variable mapping.
IDynamicRecipientVariableMapping	addVariableMapping(int id, java.lang.String subreportName, java.lang.String variableName, int providerColumnIndex) Creates a dynamic recipient variable mapping for a variable in a subreport.
boolean	removeVariableMapping(int id, java.lang.String variableName, int providerColumnIndex) Removes the specified dynamic recipient variable mapping.
boolean	removeVariableMapping(int id, java.lang.String subreportName, java.lang.String variableName, int providerColumnIndex) Removes the specified dynamic recipient variable mapping from the subreport.

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKSet

get

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

addVariableMapping

IDynamicRecipientVariableMapping addVariableMapping(int id,
                                                    java.lang.String variableName,
                                                    int providerColumnIndex)

Creates a dynamic recipient variable mapping.

Parameters:

id - the internal index of the mapping object. Use the provider column index

variableName - the name of the variable in the report that is being personalized

providerColumnIndex - the index of the column in the dynamic recipient provider. The index must match the index that was specified when the column was added to the dynamic recipient provider column collection.

Returns:

The new IDynamicRecipientVariableMapping object.

See Also:

IDynamicRecipientProviderColumns.addProviderColumn(int, java.lang.String)

removeVariableMapping

boolean removeVariableMapping(int id,
                              java.lang.String variableName,
                              int providerColumnIndex)

Removes the specified dynamic recipient variable mapping.

Parameters:

id - the internal index of the mapping object

variableName - the name of the variable in the report that is being personalized

providerColumnIndex - the index of the column in the dynamic recipient provider

Returns:

true if the mapping was removed successfully or false if the mapping could not be found.

addVariableMapping

IDynamicRecipientVariableMapping addVariableMapping(int id,
                                                    java.lang.String subreportName,
                                                    java.lang.String variableName,
                                                    int providerColumnIndex)

Creates a dynamic recipient variable mapping for a variable in a subreport.

Parameters:

id - the internal index of the mapping object. Use the provider column index

subreportName - the name of the subreport that contains the variable

variableName - the name of the variable in the report that is being personalized

providerColumnIndex - the index of the column in the dynamic recipient provider. The index must match the index that was specified when the column was added to the dynamic recipient provider column collection.

Returns:

The new IDynamicRecipientVariableMapping object.

See Also:

IDynamicRecipientProviderColumns.addProviderColumn(int, java.lang.String)

removeVariableMapping

boolean removeVariableMapping(int id,
                              java.lang.String subreportName,
                              java.lang.String variableName,
                              int providerColumnIndex)

Removes the specified dynamic recipient variable mapping from the subreport.

Parameters:

id - the internal index of the mapping object

subreportName - the name of the subreport that contains the variable

variableName - the name of the variable in the report that is being personalized

providerColumnIndex - the index of the column in the dynamic recipient provider

Returns:

true if the mapping was removed successfully or false if the mapping could not be found.