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

public interface IPublicationDynaRecipientProfileValueMappings

This interface represents dynamic recipient profile value mappings. It is used to map columns in the dynamic recipient provider to placeholders and profile values in the publication.

Method Summary

java.lang.String	getEmailAddress() Returns the name of the column in the dynamic recipient provider that contains the e-mail address of the recipient.
java.lang.String	getEnterpriseUserName() For Internal use only
java.lang.String	getFullName() Returns the name of the column in the dynamic recipient provider that contains the full name of the recipient.
java.lang.String	getName() Returns the name of the column in the dynamic recipient provider that contains the unique identifier of the recipient.
IDynamicRecipientPerDocProfileMappings	getPerDocProfileValueMappings() Returns the profile mappings collection for all schedulable documents in the publication.
IDynamicRecipientProviderColumns	getProviderColumns() Returns the dynamic recipient provider columns that are used to personalize each schedulable document in the publication.
void	setEmailAddress(java.lang.String recipentEmail) Sets the name of the column in the dynamic recipient provider that contains the e-mail address of the recipient.
void	setEnterpriseUserName(java.lang.String enterpriseUserName) For Internal use only
void	setFullName(java.lang.String recipentFullName) Sets the name of the column in the dynamic recipient provider that contains the full name of the recipient.
void	setName(java.lang.String recipentName) Sets the name of the column in the dynamic recipient provider that contains the unique identifier of the recipient.

Method Detail

getName

java.lang.String getName()

Returns the name of the column in the dynamic recipient provider that contains the unique identifier of the recipient.

Returns:

The column name.

setName

void setName(java.lang.String recipentName)
             throws SDKException

Sets the name of the column in the dynamic recipient provider that contains the unique identifier of the recipient.

This value is mapped to the %SI_OWNER% placeholder. If the publication is delivered to the SMTP destination, this placeholder can be used in the subject and body fields of the e-mail message.

Parameters:

recipentName - The column name.

Throws:

SDKException

getFullName

java.lang.String getFullName()

Returns the name of the column in the dynamic recipient provider that contains the full name of the recipient.

Returns:

The column name.

setFullName

void setFullName(java.lang.String recipentFullName)
                 throws SDKException

Sets the name of the column in the dynamic recipient provider that contains the full name of the recipient.

This value is mapped to the %SI_USERFULLNAME% placeholder. If the publication is delivered to the SMTP destination, this placeholder can be used in the subject and body fields of the e-mail message.

Parameters:

recipentFullName - The column name.

Throws:

SDKException

getEmailAddress

java.lang.String getEmailAddress()

Returns the name of the column in the dynamic recipient provider that contains the e-mail address of the recipient.

Returns:

The column name.

setEmailAddress

void setEmailAddress(java.lang.String recipentEmail)
                     throws SDKException

Sets the name of the column in the dynamic recipient provider that contains the e-mail address of the recipient.

This value is mapped to the %SI_EMAIL_ADDRESS% placeholder. If the publication is delivered to the SMTP destination, this placeholder can be used in the subject and body fields of the e-mail message as well as to specify the e-mail recipient.

Parameters:

recipentEmail - The column name.

Throws:

SDKException

getEnterpriseUserName

java.lang.String getEnterpriseUserName()

For Internal use only

setEnterpriseUserName

void setEnterpriseUserName(java.lang.String enterpriseUserName)
                           throws SDKException

For Internal use only

Throws:

SDKException

getPerDocProfileValueMappings

IDynamicRecipientPerDocProfileMappings getPerDocProfileValueMappings()
                                                                     throws SDKException

Returns the profile mappings collection for all schedulable documents in the publication.

Returns:

A IDynamicRecipientPerDocProfileMappings which contains dynamic recipient profile mapping information.

Throws:

SDKException - Thrown when Properties bag operation failed.

getProviderColumns

IDynamicRecipientProviderColumns getProviderColumns()
                                                    throws SDKException

Returns the dynamic recipient provider columns that are used to personalize each schedulable document in the publication.

Returns:

A IDynamicRecipientProviderColumns collection that contains the columns in the dynamic recipient provider.

Throws:

SDKException - Thrown when Properties bag operation failed.