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

public interface IDynamicRecipientPerDocProfileMapping

This interface represents a dynamic recipient profile mapping for a single document in a publication.

Method Summary

java.lang.String[]	getDocPersonalizationFields() Returns the names of the document personalization fields.
IDynamicRecipientVariableMappings	getDynamicRecipientVariableMappings() Returns the document personalization field mapping collection.
int	getProviderColumnIndex(java.lang.String fieldName) Returns the dynamic recipient provider column index for the specified field name.
int	getSourceDocumentID() Returns the source document ID.
void	setSourceDocumentID(int srcDocID) Sets the source document ID.

Method Detail

getSourceDocumentID

int getSourceDocumentID()

Returns the source document ID.

Returns:

The source document ID.

Throws:

SDKException - if the process is unsuccessful.

setSourceDocumentID

void setSourceDocumentID(int srcDocID)
                         throws SDKException

Sets the source document ID.

Parameters:

srcDocID - the source document ID.

Throws:

SDKException - if the process is unsuccessful.

getDynamicRecipientVariableMappings

IDynamicRecipientVariableMappings getDynamicRecipientVariableMappings()

Returns the document personalization field mapping collection.

Returns:

A collection containing the personalization field mappings.

Throws:

SDKException - if the process is unsuccessful.

getDocPersonalizationFields

java.lang.String[] getDocPersonalizationFields()

Returns the names of the document personalization fields.

Returns:

A array of personalization field names.

Throws:

SDKException - if the process is unsuccessful.

getProviderColumnIndex

int getProviderColumnIndex(java.lang.String fieldName)

Returns the dynamic recipient provider column index for the specified field name.

Parameters:

fieldName - the provider column name.

Returns:

The index of the provider column.

Throws:

SDKException - if the process is unsuccessful.