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

public interface IPublicationPersonalization

This interface represents the information that can be used for personalization on a publication object.

Method Summary

java.util.Set	getAllPersonalizationFields() Returns a read-only set of all field names that can be used in personalization of a publication, its processing.
java.util.Set	getCommonPersonalizationFields() Returns a read-only set of field names common to all dynamic recipient reports in this publication that can be used in personalization of a publication, its processing destination for example.
java.util.Set	getPersonalizationFieldsPerDoc(int docID) Returns a read-only set of field names from one particular dynamic recipient report in this publication that can be used in personalization of a publication, its processing destination for example.

Method Detail

getAllPersonalizationFields

java.util.Set getAllPersonalizationFields()
                                          throws SDKException

Returns a read-only set of all field names that can be used in personalization of a publication, its processing. destination for example. The fields are from all dynamic recipient reports included in this publication.

Returns:

Set of all field names that can be used in personalization of a publication,

Throws:

SDKException

getCommonPersonalizationFields

java.util.Set getCommonPersonalizationFields()
                                             throws SDKException

Returns a read-only set of field names common to all dynamic recipient reports in this publication that can be used in personalization of a publication, its processing destination for example. The fields are from dynamic recipient reports included in this publication.

Returns:

Set of all field names that can be used in personalization of a publication,

Throws:

SDKException

getPersonalizationFieldsPerDoc

java.util.Set getPersonalizationFieldsPerDoc(int docID)
                                             throws SDKException

Returns a read-only set of field names from one particular dynamic recipient report in this publication that can be used in personalization of a publication, its processing destination for example. The fields are from the specified dynamic recipient report.

Returns:

Set of field names in the specified dynamic recipient report that can be used in personalization of a publication,

Throws:

SDKException