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

All Known Subinterfaces:

IPublication

public interface IPublicationBase

This interface provides methods for creating and managing publications in BusinessObjects Enterprise.

A publication is a set of objects that can be scheduled and distributed to multiple recipients on a regular basis. Recipients can be either BusinessObjects Enterprise users or external users, who can receive the publication by e-mail. The set of objects includes one or more report documents (Crystal Reports, Desktop Intelligence, or Web Intelligence documents) and may also include static objects, such as Excel spreadsheets and images. The contents of the report documents in the publication can be personalized, so that recipients only see the information that is relevant to them.

Nested Class Summary

static interface	IPublicationBase.CeDataBurstingMode The data bursting mode for publications.
static interface	IPublicationBase.CeDeliveryRuleOption The delivery rule options for publications.
static interface	IPublicationBase.CeFormatType Deprecated. As of version 12.0. Use IPublicationBase.getDocumentProcessingInfo(int) to retrieve processing info.
static interface	IPublicationBase.CeProfileResolutionType The profile resolution types that can be used for a publication.

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID

Method Summary

void	checkPublicationIntegrity() Checks the publication for configuration errors and throws an SDKException if any are found.
long	getBurstingMode() Returns the bursting mode.
IDestinationPluginArtifactFormats	getDefaultDestinationPluginArtifactFormats() Returns the list of post-processing plugins that are executed for the default destination.
int	getDeliveryRuleOptions() Returns the publication delivery rule option.
IProperties	getDocumentProcessingInfo(int documentID) Returns the document processing info for the specified source document.
java.lang.Object	getDocumentProcessingInfoObject(int documentID) Returns the document processing info for the specified source document as an InfoObject instance.
java.util.Collection	getDocuments() Returns the IDs of the documents associated with this publication.
IPublicationDynamicRecipients	getDynamicRecipients() Returns the subset of dynamic recipients from the provider that will recieve the publication.
IPublicationDynaRecipientProfileValueMappings	getDynamicRecipientsProfileValueMappings() Returns the profile value mappings for dynamic recipients.
IPublicationDynamicRecipients	getDynamicRecipientsReRun() Returns the dynamic recipients for rerun/redistribution with the publication.
IPublicationDynamicRecipients	getExcludedDynamicRecipients() Returns the IDs of the excluded principals for the publication.
java.util.Collection	getExcludedPrincipals() Returns the IDs of the excluded principals for this publication.
int	getGlobalDeliveryRuleDocID() Returns the ID of the global delivery rule document.
java.lang.String	getGlobalDeliveryRuleExpression() Returns the global delivery rule expression.
java.lang.String	getLastLogUploadPosition() For internal use only.
int	getLogFileID() Returns the ID of the admin log file for this publication instance.
long	getMultiPassBursting() Deprecated. As of version 12.0. Use IPublicationBase.getBurstingMode() instead.
java.util.Set	getNoProfileUsers() Returns the IDs of the subscribed users that do not have profile values for any profile in this publication.
int	getOutputFormat() Deprecated. As of version 12.0. Use IPublicationBase.getDocumentProcessingInfo(int) to retrieve output format information.
IPublicationPersonalization	getPersonalization() Returns the personalization info of this publication.
java.lang.String	getPreviousServerName() For internal use only.
java.util.Collection	getPrincipals() Returns the IDs of the principals associated with this publication.
java.util.Collection	getPrincipalsReRun() Returns the IDs of the principals included for rerun/redistribution with the publication.
int	getProcessedRecipientCount() Returns the number of recipients processed in the most recent run of this publication.
int	getProfileResolutionType() Returns the type of profile resolution used for this publication.
java.util.Collection	getProfiles() Returns the collection of profile IDs associated with this publication.
IPublicationProfileTargets	getProfileTargets() Deprecated. As of version 12.0. Use IPublicationBase.getPublicationDocumentProfileTargets() to retrieve profile targets.
IPublicationDocumentProfileTargets	getPublicationDocumentProfileTargets() Returns the profile targets for all documents in the publication.
IPublicationEventHandlers	getPublicationEventHandlers() Returns the publication event handlers associated with the publication.
java.lang.String	getPublicationServerName() For internal use only.
IPublicationState	getPublicationState() For internal use only.
java.util.Collection	getSchedulableDocuments() Returns the schedulable documents associated with the publication.
int	getScopeBatchSize() Returns the scope batch size.
java.util.Set	getScopes() For internal use only.
java.util.Collection	getStaticDocuments() Returns the static documents associated with the publication.
int	getSucceededRecipientCount() For internal use only.
boolean	isCleanupScopeBatch() Returns whether scope batches are deleted after the publication has been completed
boolean	isDynamicRecipientsReRunAll() Returns whether the publication is delivered to all original dynamic recipients when it is redistributed.
boolean	isGlobalDeliverIfAlertIsTrue() Returns whether to deliver the publication when the alert result is true.
boolean	isPdfMergeSupported() Returns the value based on the source document types so the UI client doesn't need to know which types support PDF Merging.
boolean	isShowAllDataForNullProfileValues() Returns whether all data is included when delivering a document to recipients who have null profile values for any profiles associated with the document.
boolean	isSubscribed(int userID) Returns whether the specified user is subscribed to the publication.
void	refreshProcessingInfo(IProcessingInfo procInfo) Deprecated. As of version 12.0. Use IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties) to configure processing information.
void	removeDocumentProcessingInfo(int documentID) Removes the processing info property bag for the specified source document.
void	rerun() Runs the publication again.
void	setBurstingMode(long value) Sets the bursting mode.
void	setCleanupScopeBatch(boolean clean) Sets whether scopebactes will be deleted after a publication has been completed
void	setDeliveryRuleOptions(int deliveryRuleOptions) Sets the publication delivery rule option.
void	setDocumentProcessingInfo(int documentID, java.lang.String documentKind, IProperties documentProcessingInfo) Sets the processing info property bag for a given source document.
void	setDynamicRecipientsReRunAll(boolean value) Sets whether the publication is delivered to all original dynamic recipients when it is redistributed.
void	setGlobalDeliverIfAlertIsTrue(boolean value) Sets whether to deliver the publication when the alert result is true.
void	setGlobalDeliveryRuleDocID(int value) Sets the ID of the global delivery rule document.
void	setGlobalDeliveryRuleExpression(java.lang.String value) Sets the global delivery rule expression.
void	setLastLogUploadPosition(java.lang.String lastUpload) For internal use only.
void	setLogFileID(int value) Sets the ID of the admin log file for this publication instance.
void	setMultiPassBursting(long value) Deprecated. As of version 12.0. Use IPublicationBase.setBurstingMode(long) instead.
void	setOutputFormat(int format) Deprecated. As of version 12.0. Use IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties) to configure output formats.
void	setPreviousServerName(java.lang.String previousApsName) For internal use only.
void	setProcessedRecipientCount(int numProcessedRecipients) For internal use only.
void	setProfileResolutionType(int type) Sets the type of profile resolution used for this publication.
void	setPublicationServerName(java.lang.String value) For internal use only.
void	setScopeBatchSize(int value) Sets the scope batch size.
void	setShowAllDataForNullProfileValues(boolean value) Sets whether all data is included when delivering a document to recipients who have null profile values for any profiles associated with the document.
void	setSucceededRecipientCount(int numSucceededRecipients) For internal use only.
boolean	subscribe(int userID) Subscribes a user to the publication.
boolean	unsubscribe(int userID) Unsubscribes a user from the publication.

Field Detail

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

getDocuments

java.util.Collection getDocuments()
                                  throws SDKException

Returns the IDs of the documents associated with this publication. This includes both schedulable and static documents.

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

Returns:

A collection of document IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.getSchedulableDocuments(), IPublicationBase.getStaticDocuments()

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTS

getSchedulableDocuments

java.util.Collection getSchedulableDocuments()
                                             throws SDKException

Returns the schedulable documents associated with the publication. This includes Crystal Reports, Desktop Intelligence, and Web Intelligence documents.

Each call to this method returns a new copy of the Collection and may result in queries to the InfoStore. This collection is read-only.

To use this method, this object must contain the SI_PUBLICATION_DOCUMENTS property.

Returns:

A collection containing the schedulable IInfoObject objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.getDocuments(), IPublicationBase.getStaticDocuments()

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTS

getStaticDocuments

java.util.Collection getStaticDocuments()
                                        throws SDKException

Returns the static documents associated with the publication.

Each call to this method returns a new copy of the Collection and may result in queries to the InfoStore. This collection is read-only.

To use this method, this object must contain the SI_PUBLICATION_DOCUMENTS property.

Returns:

A collection containing the static IInfoObject objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.getSchedulableDocuments(), IPublicationBase.getDocuments()

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTS

getProfiles

java.util.Collection getProfiles()
                                 throws SDKException

Returns the collection of profile IDs associated with this publication.

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

Returns:

A collection of profile IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_PROFILES

getPrincipals

java.util.Collection getPrincipals()
                                   throws SDKException

Returns the IDs of the principals associated with this publication.

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

Returns:

A collection of principal IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS

getExcludedPrincipals

java.util.Collection getExcludedPrincipals()
                                           throws SDKException

Returns the IDs of the excluded principals for this publication.

Excluded principals do not receive the contents of the publication. If a group is subscribed to a publication, but a user in the group is an excluded principal, then that user will not receive the document.

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

Returns:

A collection containing the excluded principal IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_EXCLUDED_PRINCIPALS

getPrincipalsReRun

java.util.Collection getPrincipalsReRun()
                                        throws SDKException

Returns the IDs of the principals included for rerun/redistribution with the publication.

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

Returns:

A collection containing the principal IDs.

Throws:

SDKException - if the process was unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS_RERUN

getDynamicRecipients

IPublicationDynamicRecipients getDynamicRecipients()
                                                   throws SDKException

Returns the subset of dynamic recipients from the provider that will recieve the publication.

This collection can be used to create a subset of recipients to whom the publication is delivered. Recipients in this collection must match recipients in the dynamic recipient provider. When populated, only the dynamic recipients who are in this collection and whose profile values match those specified recieve the publication. All other dynamic recipients in the provider are ignored.

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

Returns:

A collection containing the subset of dynamic recipients who will recieve the publication.

Throws:

SDKException - if the process was unsuccessful.

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS

getDynamicRecipientsProfileValueMappings

IPublicationDynaRecipientProfileValueMappings getDynamicRecipientsProfileValueMappings()
                                                                                       throws SDKException

Returns the profile value mappings for dynamic recipients.

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

Returns:

A collection of dynamic recipient profile value mappings between dynamic recipient data provider fields and property values.

Throws:

SDKException - if the process was unsuccessful.

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS_PROFILE_VALUE_MAPPINGS

getExcludedDynamicRecipients

IPublicationDynamicRecipients getExcludedDynamicRecipients()
                                                           throws SDKException

Returns the IDs of the excluded principals for the publication.

Excluded principals do not receive the publication. If a group is subscribed to a publication, but a user in the group is an excluded principal, that user does not receive the publication.

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

Returns:

The collection of excluded principal IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_EXCLUDED_DYNAMIC_RECIPIENTS

getDynamicRecipientsReRun

IPublicationDynamicRecipients getDynamicRecipientsReRun()
                                                        throws SDKException

Returns the dynamic recipients for rerun/redistribution with the publication.

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

Returns:

A collection of dynamic recipient list for publication redistribution.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.rerun()

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS_RERUN

isDynamicRecipientsReRunAll

boolean isDynamicRecipientsReRunAll()
                                    throws SDKException

Returns whether the publication is delivered to all original dynamic recipients when it is redistributed. If false, the publication is only redistributed to dynamic recipients in the collection returned by IPublicationBase.getDynamicRecipientsReRun().

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

Returns:

A boolean indicating whether to redistribute to all original dynamic recipients.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.rerun(), IPublicationBase.setDynamicRecipientsReRunAll(boolean)

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS_RERUN_ALL

setDynamicRecipientsReRunAll

void setDynamicRecipientsReRunAll(boolean value)
                                  throws SDKException

Sets whether the publication is delivered to all original dynamic recipients when it is redistributed. If false, the publication is only redistributed to dynamic recipients in the collection returned by IPublicationBase.getDynamicRecipientsReRun().

Parameters:

value - A boolean indicating whether to redistribute to all original dynamic recipients.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.rerun(), IPublicationBase.isDynamicRecipientsReRunAll()

getOutputFormat

int getOutputFormat()

Deprecated. As of version 12.0. Use IPublicationBase.getDocumentProcessingInfo(int) to retrieve output format information.

Returns the output format type for this publication.

This method has been deprecated. It only supports retrieving the output format for publications that contain a single Desktop Intelligence document and that have only one output format.

Returns:

An int of type CeFormatType that specifies the output format for this publication.

See Also:

IPublicationBase.CeFormatType

InfoObject properties to query for:

SI_PROCESSINFO.SI_FORMAT_INFO
SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

setOutputFormat

void setOutputFormat(int format)
                     throws SDKException

Deprecated. As of version 12.0. Use IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties) to configure output formats.

Sets the output format type for a publication.

This method has been deprecated. It only supports setting the output format for publications that contain a single Desktop Intelligence document and that have only one output format.

Parameters:

format - An int of type CeFormatType that specifies the output format for this publication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.CeFormatType

getProfileTargets

IPublicationProfileTargets getProfileTargets()
                                             throws SDKException

Deprecated. As of version 12.0. Use IPublicationBase.getPublicationDocumentProfileTargets() to retrieve profile targets.

Returns the collection of profile targets associated with this publication.

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

Returns:

A collection of profile targets.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTPROFILE_TARGETS

refreshProcessingInfo

void refreshProcessingInfo(IProcessingInfo procInfo)
                           throws SDKException

Deprecated. As of version 12.0. Use IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties) to configure processing information.

Sets the processing info for a publication.

This method has been deprecated. It only supports publications that contain a single Desktop Intelligence document.

Note: Only call this method before the publication is scheduled; do not commit changes to the publication if this method has been called.

Parameters:

procInfo - The processing information to be used to process the document in this publication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

subscribe

boolean subscribe(int userID)
                  throws SDKException

Subscribes a user to the publication.

Note: To subscribe a group, add the group ID to the collection returned by IPublicationBase.getPrincipals().

Parameters:

userID - The ID of the user to add to the list of subscribers.

Returns:

true if the user or group is successfully subscribed, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS
SI_EXCLUDED_PRINCIPALS

unsubscribe

boolean unsubscribe(int userID)
                    throws SDKException

Unsubscribes a user from the publication.

Note: To unsubscribe a group, remove the group ID from the collection returned by IPublicationBase.getPrincipals().

Parameters:

userID - The ID of the user to remove from the list of subscribers.

Returns:

true if the user is successfully unsubscribed, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS
SI_EXCLUDED_PRINCIPALS

isSubscribed

boolean isSubscribed(int userID)
                     throws SDKException

Returns whether the specified user is subscribed to the publication.

Note: To determine if a group is subscribed, look for the group ID in the collection returned by IPublicationBase.getPrincipals().

Parameters:

userID - The ID of the user to check.

Returns:

true if the user is subscribed to this publication, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS
SI_EXCLUDED_PRINCIPALS

getNoProfileUsers

java.util.Set getNoProfileUsers()
                                throws SDKException

Returns the IDs of the subscribed users that do not have profile values for any profile in this publication. In this case, the user receives the complete, unfiltered report.

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

Returns:

A collection containing the IDs of subscribed users that do not have profile values for any profile in this publication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PRINCIPALS
SI_EXCLUDED_PRINCIPALS
SI_PUBLICATION_PROFILES
SI_PUBLICATION_DOCUMENTPROFILE_TARGETS

getProfileResolutionType

int getProfileResolutionType()
                             throws SDKException

Returns the type of profile resolution used for this publication.

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

Returns:

An int of type CeProfileResolutionType that specifies the profile resolution type for this publication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.CeProfileResolutionType

InfoObject properties to query for:

SI_TYPE

setProfileResolutionType

void setProfileResolutionType(int type)
                              throws SDKException

Sets the type of profile resolution used for this publication.

Parameters:

type - An int of type CeProfileResolutionType that specifies the profile resolution type for this publication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.CeProfileResolutionType

getScopes

java.util.Set getScopes()
                        throws SDKException

For internal use only.

Throws:

SDKException

InfoObject properties to query for:

SI_PRINCIPALS
SI_EXCLUDED_PRINCIPALS
SI_PUBLICATION_PROFILES
SI_PUBLICATION_DOCUMENTPROFILE_TARGETS

getPublicationEventHandlers

IPublicationEventHandlers getPublicationEventHandlers()
                                                      throws SDKException

Returns the publication event handlers associated with the publication.

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

Returns:

a collection of publication event handlers.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_EVENT_HANDLERS

getGlobalDeliveryRuleDocID

int getGlobalDeliveryRuleDocID()

Returns the ID of the global delivery rule document. The source document must be a Web Intelligence, Desktop Intelligence, or a Crystal Reports document.

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

Returns:

The ID of the global delivery rule document or -1 if a document was not found.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_GLOBAL_DELIVERY_RULE_DOC_OBJECT_ID

setGlobalDeliveryRuleDocID

void setGlobalDeliveryRuleDocID(int value)
                                throws SDKException

Sets the ID of the global delivery rule document. The source document must be a Web Intelligence, Desktop Intelligence, or a Crystal Reports document.

Parameters:

value - the ID of the global delivery rule document.

Throws:

SDKException - Thrown if an error occurs while adding the new property.

getGlobalDeliveryRuleExpression

java.lang.String getGlobalDeliveryRuleExpression()

Returns the global delivery rule expression. This value is evaluated differently depending on the type of the global delivery rule document. For a Web Intelligence or Desktop Intelligence document, the expression must be a boolean formula, and the publication will only be processed if the expression evaluates to true. For a Crystal Reports document, the expression must be the name of an Alert, and the publication will only be processed if the Alert is executed.

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

Returns:

A String containing the global delivery rule expression.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_GLOBAL_DELIVERY_RULE_EXPRESSION

setGlobalDeliveryRuleExpression

void setGlobalDeliveryRuleExpression(java.lang.String value)
                                     throws SDKException

Sets the global delivery rule expression. This value is evaluated differently depending on the type of the global delivery rule document. For a Web Intelligence or Desktop Intelligence document, the expression must be a boolean formula, and the publication will only be processed if the expression evaluates to true. For a Crystal Reports document, the expression must be the name of an alert, and the publication will only be processed if the alert is executed.

Parameters:

value - A String containing the global delivery rule expression.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isGlobalDeliverIfAlertIsTrue

boolean isGlobalDeliverIfAlertIsTrue()
                                     throws SDKException

Returns whether to deliver the publication when the alert result is true. This only applies if the global delivery rule document is a Crystal Reports document.

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

Returns:

true if the publication is delivered when the alert result is true or false if the publication is delivered when the alert result is false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.setGlobalDeliveryRuleExpression(java.lang.String)

InfoObject properties to query for:

SI_DELIVER_IF_ALERT_IS_TRUE

setGlobalDeliverIfAlertIsTrue

void setGlobalDeliverIfAlertIsTrue(boolean value)
                                   throws SDKException

Sets whether to deliver the publication when the alert result is true. This only applies if the global delivery rule document is a Crystal Reports document.

Parameters:

value - true to deliver the publication when the alert result is true or false to deliver it when the alert result is false

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.setGlobalDeliveryRuleExpression(java.lang.String)

isShowAllDataForNullProfileValues

boolean isShowAllDataForNullProfileValues()

Returns whether all data is included when delivering a document to recipients who have null profile values for any profiles associated with the document.

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

Returns:

true if all data is shown to recipients with null profile values, false otherwise.

Throws:

SDKException - This is thrown 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 all data is included when delivering a document to recipients who have null profile values for any profiles associated with the document.

Parameters:

value - set to true to show all data to recipients with null profile values, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMultiPassBursting

long getMultiPassBursting()
                          throws SDKException

Deprecated. As of version 12.0. Use IPublicationBase.getBurstingMode() instead.

Returns whether multiple pass bursting is used. Default value is 0.

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

Returns:

0 for single pass bursting or 1 for multiple pass bursting.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_MULTIPASSBURSTING

setMultiPassBursting

void setMultiPassBursting(long value)
                          throws SDKException

Deprecated. As of version 12.0. Use IPublicationBase.setBurstingMode(long) instead.

Sets whether multiple pass bursting is used.

Parameters:

value - Set to 0 for single pass bursting or 1 for multiple pass bursting.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getBurstingMode

long getBurstingMode()
                     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 - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_MULTIPASSBURSTING

setBurstingMode

void setBurstingMode(long value)
                     throws SDKException

Sets the bursting mode.

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getScopeBatchSize

int getScopeBatchSize()
                      throws SDKException

Returns the scope batch size.

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

Returns:

An int containing the the scope batch size.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_SCOPE_BATCH_SIZE

setScopeBatchSize

void setScopeBatchSize(int value)
                       throws SDKException

Sets the scope batch size. If multiple pass bursting mode is enabled, the scope batch size can be adjusted to improve performance.

Parameters:

value - An int containing the scope batch size.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.setBurstingMode(long)

getPublicationDocumentProfileTargets

IPublicationDocumentProfileTargets getPublicationDocumentProfileTargets()
                                                                        throws SDKException

Returns the profile targets for all documents in the publication.

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

Returns:

An IPublicationDocumentProfileTargets collection containing the profile targets.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTPROFILE_TARGETS

getPublicationState

IPublicationState getPublicationState()

For internal use only.

InfoObject properties to query for:

SI_PUBLICATION_LAST_STATE

getDocumentProcessingInfo

IProperties getDocumentProcessingInfo(int documentID)
                                      throws SDKException

Returns the document processing info for the specified source document.

The document processing info contains the following information:

The source document ID.

The source document kind.

Customized processing properties for the document.

Customized processing properties include:

Standard processing properties such as prompts, database logons, and printer options.

Output formats for publication.

Delivery rules and delivery rule results.

Publication failover recovery state information.

Other arbitrary processing infos for the document.

To read this value, this object must contain the processing info. (The query that retrieved the object must include the SI_PROCESSINFO property.)

Parameters:

documentID - the ID of the document

Returns:

An IProperties collection containing processing info for the document.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties), IPublicationBase.getDocumentProcessingInfoObject(int)

InfoObject properties to query for:

SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

getDocumentProcessingInfoObject

java.lang.Object getDocumentProcessingInfoObject(int documentID)
                                                 throws SDKException

Returns the document processing info for the specified source document as an InfoObject instance.

For convenience, the object can be cast to IReportProcessingInfo, IWebiFormatInfo, or IFullClientFormatInfo objects. The type of object returned is based on the documentKind used in setDocumentProcessingInfo. Consequentially, the object can also be cast to a IProcessingPublicationInfo object.

Note that the appropriate plugin SDK must be available in the classpath for this to work - cereports.jar for IReportProcessingInfo, biplugins.jar for IWebIProcessingInfo and IFullClientProcessingInfo

Example of updating document processing info: // IPublication myPublication = ... // int reportID = ... IReportProcessingInfo reportInfo = myPublication.getDocumentProcessingInfoObject(reportID); reportInfo.setDeliveryRuleExpression("some updated expression"); // etc... myPublication.setDocumentProcessingInfo(reportID, CeKind.CRYSTAL_REPORT, myCrystalReport.getProcessingInfo().properties()); myPublication.save();

Parameters:

documentID - An int indicating which document processing properties to be retrieved

Returns:

An IInfoObject the customized processing properties for the document.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.getDocumentProcessingInfo(int), IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties)

InfoObject properties to query for:

SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

setDocumentProcessingInfo

void setDocumentProcessingInfo(int documentID,
                               java.lang.String documentKind,
                               IProperties documentProcessingInfo)
                               throws SDKException

Sets the processing info property bag for a given source document.

PerDocProcessingInfo is a Collection containing elements with the following information - source document ID - customized processing properties for the document

Customized properties includes:
1. Traditional processing properties like prompts, logons, printer options.
2. Multiple Formats for publication.
3. Newly added delivery rules and delivery rule results.
4. Newly added failover recovery state bags.
5. Other arbitrary processing infos for the document.

setDocumentProcessingInfo is used to set the processing properties for a document that does not yet exist in the PerDocProcessingInfo collection

Example of setting document processing info: // IReport myCrystalReport = ... // IPublication myPublication = ... myPublication.setDocumentProcessingInfo( myCrystalReport.getID(), CeKind.CRYSTAL_REPORT, myCrystalReport.getProcessingInfo().properties()); myPublication.save(); Example of updating document processing info: // IPublication myPublication = ... // int reportID = ... IReport myCrystalReport = (IReport)eSession.getPluginManager().getPluginInterface( CeKind.CRYSTAL_REPORT, IPluginMgr.Type.DESKTOP); IProperties processingProperties = myPublication.getDocumentProcessingInfo(reportID); myCrystalReport.getProcessingInfo().properties().putAll(processingProperties); IReportProcessingInfo processingInfo = (IReportProcessingInfo)myCrystalReport; processingInfo.setDeliveryRuleExpression("some updated expression"); // etc... myPublication.setDocumentProcessingInfo(reportID, CeKind.CRYSTAL_REPORT, myCrystalReport.getProcessingInfo().properties()); myPublication.save();

Parameters:

documentID - An int indicating which document processing properties to be added

documentKind - An String indicating the kind(CeKind string)of the document

documentProcessingInfo - An IProperties the customized processing properties bag used to publish the document.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

removeDocumentProcessingInfo

void removeDocumentProcessingInfo(int documentID)

Removes the processing info property bag for the specified source document.

Parameters:

documentID - the ID of the document whose processing properties are to be removed or -1 to remove all processing properties for all documents.

See Also:

IPublicationBase.setDocumentProcessingInfo(int, java.lang.String, com.crystaldecisions.sdk.properties.IProperties)

InfoObject properties to query for:

SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC

getLogFileID

int getLogFileID()

Returns the ID of the admin log file for this publication instance.

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

Returns:

An int containing the ID of the log file for this publication instance.

InfoObject properties to query for:

SI_PUBLICATION_LOG_FILE_ID

setLogFileID

void setLogFileID(int value)
                  throws SDKException

Sets the ID of the admin log file for this publication instance.

Parameters:

value - the ID of the Txt object that contains the admin log file for this publication instance.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPublicationServerName

java.lang.String getPublicationServerName()

For internal use only.

InfoObject properties to query for:

SI_PUBLICATION_SERVER_NAME

setPublicationServerName

void setPublicationServerName(java.lang.String value)

For internal use only.

checkPublicationIntegrity

void checkPublicationIntegrity()
                               throws SDKException

Checks the publication for configuration errors and throws an SDKException if any are found.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PUBLICATION_DOCUMENTS
SI_SCHEDULEINFO

getDeliveryRuleOptions

int getDeliveryRuleOptions()

Returns the publication delivery rule option. Possible values are defined in IPublicationBase.CeDeliveryRuleOption.

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

Returns:

An int containing the delivery rule option.

InfoObject properties to query for:

SI_PROCESSINFO.SI_DELIVERY_RULE_OPTIONS

setDeliveryRuleOptions

void setDeliveryRuleOptions(int deliveryRuleOptions)
                            throws SDKException

Sets the publication delivery rule option. Possible values are defined in IPublicationBase.CeDeliveryRuleOption.

Parameters:

deliveryRuleOptions - An int that specifies the delivery rule option.

Throws:

SDKException - This is thrown if the process is unsuccessful.

rerun

void rerun()
           throws SDKException

Runs the publication again. This method can be executed on a publication instance if the original execution failed or to redistribute the publication to a specific group of recipients.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPublicationBase.getPrincipalsReRun(), IPublicationBase.getDynamicRecipientsReRun(), IPublicationBase.isDynamicRecipientsReRunAll()

getDefaultDestinationPluginArtifactFormats

IDestinationPluginArtifactFormats getDefaultDestinationPluginArtifactFormats()

Returns the list of post-processing plugins that are executed for the default destination.

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

Returns:

A collection containing the post-processing plugins for the default destination.

InfoObject properties to query for:

SI_DEFAULT_DESTINATION_PLUGIN_FORMATS

setCleanupScopeBatch

void setCleanupScopeBatch(boolean clean)

Sets whether scopebactes will be deleted after a publication has been completed

Parameters:

clean - A boolean indicating whether scopebactes will be deleted after a publication has been completed

isCleanupScopeBatch

boolean isCleanupScopeBatch()

Returns whether scope batches are deleted after the publication has been completed

Returns:

true if scope batches are deleted after the publication has been completed, otherwise false.

InfoObject properties to query for:

SI_CLEANUP_SCOPEBATCH

getProcessedRecipientCount

int getProcessedRecipientCount()

Returns the number of recipients processed in the most recent run of this publication.

Returns:

The number of recipients processed.

InfoObject properties to query for:

SI_NUM_PROCESSED_RECIPIENTS

setProcessedRecipientCount

void setProcessedRecipientCount(int numProcessedRecipients)

For internal use only.

getSucceededRecipientCount

int getSucceededRecipientCount()

For internal use only.

InfoObject properties to query for:

SI_NUM_SUCCEEDED_RECIPIENTS

setSucceededRecipientCount

void setSucceededRecipientCount(int numSucceededRecipients)

For internal use only.

setLastLogUploadPosition

void setLastLogUploadPosition(java.lang.String lastUpload)

For internal use only.

getLastLogUploadPosition

java.lang.String getLastLogUploadPosition()

For internal use only.

InfoObject properties to query for:

SI_LAST_LOG_UPLOAD_POSITION

setPreviousServerName

void setPreviousServerName(java.lang.String previousApsName)

For internal use only.

getPreviousServerName

java.lang.String getPreviousServerName()

For internal use only.

InfoObject properties to query for:

SI_PREVIOUS_SERVER_NAME

isPdfMergeSupported

boolean isPdfMergeSupported()

Returns the value based on the source document types so the UI client doesn't need to know which types support PDF Merging.

getPersonalization

IPublicationPersonalization getPersonalization()
                                               throws SDKException

Returns the personalization info of this publication.

Returns:

IPublicationPersonalization representing personalization info used by this publication.

Throws:

SDKException

InfoObject properties to query for:

SI_DYNAMIC_RECIPIENTS_PROFILE_VALUE_MAPPINGS, SI_PUBLICATION_DOCUMENTPROFILE_TARGETS