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

All Superinterfaces:

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

public interface IDynamicRecipientProfileValues
extends ISDKSet

Method Summary

IDynamicRecipientProfileValue	addExisting(int iProviderColumnOrVariableID, java.lang.Object value) Adds a existing dynamicRecipientProfileValue to the collection.
IDynamicRecipientProfileValue	addNew(int iProviderColumnOrVariableID, java.lang.Object value) Adds a new dynamicRecipientProfileValue to the collection.
java.lang.String	find(int iProviderColumnOrVariableID) Deprecated. Use IDynamicRecipientProfileValues.findObject(int) instead.
java.lang.Object	findObject(int iProviderColumnOrVariableID) Find the dynamicRecipientProfileValue for the given iProviderColumnOrVariableID.

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

addNew

IDynamicRecipientProfileValue addNew(int iProviderColumnOrVariableID,
                                     java.lang.Object value)
                                     throws SDKException

Adds a new dynamicRecipientProfileValue to the collection. This method should always be used to add an dynamicRecipientProfileValue to the end of the aliases collection.

Parameters:

iProviderColumnOrVariableID - when kind is ScopeBatch, this is ProviderColumnID, when kind belongs to MasterScopeBatchDocument, this is variableID;

value - in case of ScopeBatch, the value is like "%SI_USERFULLNAME% Vancouver" in case of MasterScopeBatchDocument, the value is like: "Yanlun Ma, Y.Ma Vancouver"

Returns:

An IDynamicRecipientProfileValue object containing the newly created dynamic recipient profile value.

Throws:

java.lang.NullPointerException - If the iProviderColumnOrVariableID or value is null

SDKException.

SDKException

addExisting

IDynamicRecipientProfileValue addExisting(int iProviderColumnOrVariableID,
                                          java.lang.Object value)
                                          throws SDKException

Adds a existing dynamicRecipientProfileValue to the collection. This method should be used to replace a existing dynamicRecipientProfileValue.

Parameters:

iProviderColumnOrVariableID - when kind is ScopeBatch, this is ProviderColumnID, when kind belongs to MasterScopeBatchDocument, this is variableID;

value - in case of ScopeBatch, the value is like "%SI_USERFULLNAME% Vancouver" in case of MasterScopeBatchDocument, the value is like: "Yanlun Ma, Y.Ma Vancouver"

Returns:

An IDynamicRecipientProfileValue object containing the updated dynamic recipient profile value.

Throws:

java.lang.NullPointerException - If the iProviderColumnOrVariableID or value is null

SDKException

find

java.lang.String find(int iProviderColumnOrVariableID)
                      throws SDKException

Deprecated. Use IDynamicRecipientProfileValues.findObject(int) instead.

Find the dynamicRecipientProfileValue for the given iProviderColumnOrVariableID.

Parameters:

iProviderColumnOrVariableID - when kind is ScopeBatch, this is ProviderColumnID, when kind belongs to MasterScopeBatchDocument, this is variableID;

Returns:

A String value, in case of ScopeBatch, the value is like "%SI_USERFULLNAME% Vancouver" in case of MasterScopeBatchDocument, the value is like: "Yanlun Ma, Y.Ma Vancouver"

Throws:

An - SDKException.

SDKException

findObject

java.lang.Object findObject(int iProviderColumnOrVariableID)
                            throws SDKException

Find the dynamicRecipientProfileValue for the given iProviderColumnOrVariableID.

Parameters:

iProviderColumnOrVariableID - when kind is ScopeBatch, this is ProviderColumnID, when kind belongs to MasterScopeBatchDocument, this is variableID;

Returns:

A Object value, in case of ScopeBatch, the value is like "%SI_USERFULLNAME% Vancouver" in case of MasterScopeBatchDocument, the value is like: "Yanlun Ma, Y.Ma Vancouver"

Throws:

An - SDKException.

SDKException