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

public interface IPublicationDocumentProfileTarget

This interface defines a publication profile target for a source document.

A publication profile target is associated with a profile and a source document in a publication. When the publication is scheduled, the profile values are mapped to the variables, parameters, and elements in the associated source document.

Method Summary

int	getSourceDocumentID() Returns the source document ID.
IPublicationDocumentVariableMappings	getVariableMappings() Returns the collection of variable mappings associated with the document.
void	setSourceDocumentID(int docId) Sets the target document ID.

Method Detail

getSourceDocumentID

int getSourceDocumentID()

Returns the source document ID.

Returns:

The source document ID.

setSourceDocumentID

void setSourceDocumentID(int docId)
                         throws SDKException

Sets the target document ID.

Parameters:

docId - the source document ID

Throws:

SDKException - if the process is unsuccessful.

getVariableMappings

IPublicationDocumentVariableMappings getVariableMappings()

Returns the collection of variable mappings associated with the document.

Returns:

An IPublicationDocumentVariableMappings collection containing the variable mappings.

Throws:

SDKException - if the process is unsuccessful.