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

All Known Subinterfaces:

IAgnostic, IContent, IExcel, IFullClient, IPDF, IPowerPoint, IReport, IRTF, ITxt, IWebi, IWord

public interface IPublicationInfo

This interface defines common publication properties that need to be implemented by publishable documents.

The PublicationInfoHelper which implements IPublicationInfo, is used by document plugins to provide accessors for the publication properties.

Method Summary

int	getArtifactParentID() Returns the artifact parent ID from the master scope batch document.
IDestinationProgIDs	getDestinationProgIDs() Returns a collection of prog IDs that specify the destinations for the publication.
IDynamicRecipientVariableMappings	getDynamicRecipientVariableMappings() Returns the dynamic recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).
java.lang.String	getFormat() Returns the format of this artifact.
long	getMultiPassBursting() Returns the bursting mode.
IPublicationDocumentVariableMappings	getPublicationDocumentVariableMappings() Returns the SAP BusinessObjects Enterprise recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).
int	getScopeBatch() For an artifact or merged artifact, returns the ScopeBatch ID.
java.util.Collection	getScopeBatchDocArtifacts() Deprecated. This method will be removed in a future version.
int	getScopeID() Index into the bag of scopes contained within this objects' corresponding ScopeBatch Objects.
java.util.Collection	getSourceDocuments() Returns a collection containing IDs of the source documents for the generated artifacts and scope batch documents.
boolean	isPluginArtifact() Returns whether the artifact was created via a post-processing plugin.
boolean	isPublicationGlobalDeliveryRuleJob() Returns the global delivery rule indicator.
boolean	isPublicationJob() Returns whether the object runnable job is part of a publication run.
boolean	isShowAllDataForNullProfileValues() Returns whether recipients that have null profile values are shown all the data in the report.
void	setArtifactParentID(int artifactParentID) Sets the artifact parent ID in the master scope batch document.
void	setFormat(java.lang.String value) Sets the format of this artifact.
void	setMultiPassBursting(long multiPassBursting) Sets the bursting mode.
void	setPluginArtifact(boolean bIsPluginArtifact) Sets whether the artifact was created via a post-processing plugin.
void	setPublicationDocumentVariableMappings(IPublicationDocumentVariableMappings variableMappings) Sets the SAP BusinessObjects Enterprise recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).
void	setPublicationGlobalDeliveryRuleJob(boolean value) Sets the global delivery rule indicator.
void	setPublicationJob(boolean value) Sets whether the object runnable job is part of a publication run.
void	setScopeBatch(int scopeBatchID) For an artifact or merged artifact, sets the ScopeBatch ID.
void	setScopeID(int scopeID) Index into the bag of scopes contained within this objects' corresponding ScopeBatch Objects.
void	setShowAllDataForNullProfileValues(boolean value) Sets whether recipients that have null profile values are shown all the data in the report.

Method Detail

isPublicationJob

boolean isPublicationJob()
                         throws SDKException

Returns whether the object runnable job is part of a publication run.

Returns:

true if the job is a part of a publication.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_IS_PUBLICATION_JOB

setPublicationJob

void setPublicationJob(boolean value)

Sets whether the object runnable job is part of a publication run.

Parameters:

value - a boolean that indicates whether the object has been read

isPublicationGlobalDeliveryRuleJob

boolean isPublicationGlobalDeliveryRuleJob()
                                           throws SDKException

Returns the global delivery rule indicator. If true, the info object runnable job is a global delivery rule job, and the job is used to evaluate the delivery rule. If the job is a global delivery rule job, the publication should not proceed with processing.

Returns:

true if the object has been read.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_IS_PUBLICATION_GLOBAL_DELIVERY_RULE_JOB

setPublicationGlobalDeliveryRuleJob

void setPublicationGlobalDeliveryRuleJob(boolean value)

Sets the global delivery rule indicator. When set to true, the info object runnable job is a global delivery rule job, and the job is used to evaluate the delivery rule. So, when the job is a global delivery rule job, the publication should not proceed with processing.

Parameters:

value - a boolean that indicates whether the object has been read

isShowAllDataForNullProfileValues

boolean isShowAllDataForNullProfileValues()
                                          throws SDKException

Returns whether recipients that have null profile values are shown all the data in the report. The default is false.

Returns:

true if recipients are shown all report data

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SHOW_ALL_DATA_FOR_NULL_PROFILE_VALUES

setShowAllDataForNullProfileValues

void setShowAllDataForNullProfileValues(boolean value)
                                        throws SDKException

Sets whether recipients that have null profile values are shown all the data in the report.

Parameters:

value - a boolean that indicates whether recipients are shown all report data

Throws:

SDKException - if the process is unsuccessful.

getScopeID

int getScopeID()
               throws SDKException

Index into the bag of scopes contained within this objects' corresponding ScopeBatch Objects. The combination of ScopeBatch ID and Scope ID uniquely identifies a scope.

Returns:

An integer representing the index of the scope in this object's ScopeBatch object.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SCOPE_ID

setScopeID

void setScopeID(int scopeID)

Index into the bag of scopes contained within this objects' corresponding ScopeBatch Objects. The combination of ScopeBatch ID and Scope ID uniquely identifies a scope.

Parameters:

scopeID - an int representing the index of the scope in this object's ScopeBatch object

getMultiPassBursting

long getMultiPassBursting()
                          throws SDKException

Returns the bursting mode. The value corresponds to a constant defined in IPublicationBase.CeDataBurstingMode.

To read this value, this object must contain the SI_MULTIPASSBURSTING property.

Returns:

A long indicating the bursting mode. The default value is IPublicationBase.CeDataBurstingMode.ceSinglePass.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_MULTIPASSBURSTING

setMultiPassBursting

void setMultiPassBursting(long multiPassBursting)

Sets the bursting mode.

Parameters:

multiPassBursting - A value that corresponds to a constant defined in IPublicationBase.CeDataBurstingMode.

Throws:

SDKException - if the process is unsuccessful.

isPluginArtifact

boolean isPluginArtifact()
                         throws SDKException

Returns whether the artifact was created via a post-processing plugin.

Returns:

true if the artifact was generated via a plugin.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_IS_PLUGIN_ARTIFACT

setPluginArtifact

void setPluginArtifact(boolean bIsPluginArtifact)

Sets whether the artifact was created via a post-processing plugin.

Parameters:

bIsPluginArtifact - a boolean indicating whether the artifact was generated via a plugin

getScopeBatchDocArtifacts

java.util.Collection getScopeBatchDocArtifacts()
                                               throws SDKException

Deprecated. This method will be removed in a future version.

This method always returns an empty collection. It used to return the artifacts related to scope batch document under the ScopeBatchDocument-Artifact relationship, but that relationship is no longer used.

Returns:

A empty collection.

Throws:

SDKException - if the process is unsuccessful.

getDestinationProgIDs

IDestinationProgIDs getDestinationProgIDs()

Returns a collection of prog IDs that specify the destinations for the publication.

Returns:

A collection of destinations represented by the destination prog IDs.

InfoObject properties to query for:

SI_DESTINATION_PROGIDS

getSourceDocuments

java.util.Collection getSourceDocuments()
                                        throws SDKException

Returns a collection containing IDs of the source documents for the generated artifacts and scope batch documents.

Returns:

The collection of the source document IDs.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_ARTIFACTS_SOURCEDOC

getScopeBatch

int getScopeBatch()
                  throws SDKException

For an artifact or merged artifact, returns the ScopeBatch ID.

Returns:

The scopeBatch object ID.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_ARTIFACTS_SCOPEBATCH

setScopeBatch

void setScopeBatch(int scopeBatchID)
                   throws SDKException

For an artifact or merged artifact, sets the ScopeBatch ID.

Parameters:

scopeBatchID - the ScopeBatch object ID

Throws:

SDKException - if the process is unsuccessful.

getDynamicRecipientVariableMappings

IDynamicRecipientVariableMappings getDynamicRecipientVariableMappings()
                                                                      throws SDKException

Returns the dynamic recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).

Returns:

The collection of dynamic recipient variable mappings.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS_PROFILE_VALUE_MAPPINGS
SI_VARIABLE_MAPPINGS

getPublicationDocumentVariableMappings

IPublicationDocumentVariableMappings getPublicationDocumentVariableMappings()
                                                                            throws SDKException

Returns the SAP BusinessObjects Enterprise recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).

Returns:

The collection of SAP BusinessObjects Enterprise recipient variable mappings.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTPROFILE_TARGETS
SI_VARIABLE_MAPPINGS

setPublicationDocumentVariableMappings

void setPublicationDocumentVariableMappings(IPublicationDocumentVariableMappings variableMappings)
                                            throws SDKException

Sets the SAP BusinessObjects Enterprise recipient variable mappings for the current master scope batch document (the Desktop Intelligence, Web Intelligence, or Crystal Reports document).

Parameters:

variableMappings - collection of SAP BusinessObjects Enterprise recipient variable mappings

Throws:

SDKException - if the process is unsuccessful.

getArtifactParentID

int getArtifactParentID()
                        throws SDKException

Returns the artifact parent ID from the master scope batch document. This is used by processing plugins to set the parent ID of generated artifacts properly.

Returns:

The source document object ID.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_ARTIFACT_PARENT_ID

setArtifactParentID

void setArtifactParentID(int artifactParentID)
                         throws SDKException

Sets the artifact parent ID in the master scope batch document. This is used by processing plugins to set the parent ID of generated artifacts properly.

Parameters:

artifactParentID - the source document object ID

Throws:

SDKException - if the process is unsuccessful.

getFormat

java.lang.String getFormat()

Returns the format of this artifact.

Returns:

A String representing the format of this artifact.

InfoObject properties to query for:

SI_FORMAT

setFormat

void setFormat(java.lang.String value)

Sets the format of this artifact.

Parameters:

value - a String representing the format of this artifact