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

All Known Subinterfaces:

IFullClient, IFullClientBase, IFullClientProcessingInfo, IReport, IReportBase, IReportProcessingInfo, IWebi, IWebiBase, IWebiProcessingInfo

public interface IProcessingPublicationInfo

IProcessingPublicationInfo interface defines common publication properties contained in processing bag, It needs to be implemented by publishable documents.

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

Method Summary

java.lang.String	getDeliveryRuleExpression() Get Publication level delivery rule expression.
boolean	getDeliveryRuleResults(int scopeIDWithinScopeBatch) Returns the delivery result for the specified scope id DeliveryRuleResults is a PropertyBag of ( SI_SCOPE_ID, Boolean ), where the Boolean value is the recipient-level delivery rule result for recipients of specified scope on this document.
boolean	getDeliverySkipped() Gets the delivery skipped flag.
IFormatInfos	getFormatInfos() Returns the multiple formats info for the publication.
boolean	getIsDynamicRecipientsScopeBatch() Returns a boolean to indicate if this scopebatch scopes is dynamic recipients scopes.
boolean	getPublicationKeepSavedData() Returns the flag of publication keep saved data.
long	getPublicationLastState() Returns the publication last state.
IScopeBatchScopes	getScopeBatchScopes() Returns a set of scopes represented by this scope batch.
int	getSourceDocumentID() Returns the source document's ID associated with this scope batch master document
boolean	isDeliverEmptyDocument() Returns whether to delivery empty document.
boolean	isDeliverIfAlertIsTrue() Get Publication level delivery rule alert setting.
void	removeDeliveryRuleResults(int scopeIDWithinScopeBatch) Removes delivery rule results for a givenb scope.
void	setDeliverEmptyDocument(boolean bDeliveryEmptyDocument) Sets the rule of whether to delivery empty document.
void	setDeliverIfAlertIsTrue(boolean value) Set Publication level delivery rule alert setting.
void	setDeliveryRuleExpression(java.lang.String deliveryRuleExpression) Set Publication level delivery rule expression.
void	setDeliveryRuleResults(int scopeIDWithinScopeBatch, boolean bDeliverySkipped) setDeliveryRuleResults will set the delivery boolean value for the given scope id DeliveryRuleResults is a PropertyBag of ( SI_SCOPE_ID, Boolean ), where the Boolean value is the recipient-level delivery rule result for recipients of specified scope on this document.
void	setDeliverySkipped(boolean bDeliverySkipped) Sets the delivery skipped flag.
void	setIsDynamicRecipientsScopeBatch(boolean dynamicRecipientScopes) Sets boolean value to indicate if the scopebatch scopes is dynamic recipients scopes.
void	setPublicationKeepSavedData(boolean bKeepSavedData) Set the flag of publication keep saved data.
void	setPublicationLastState(long lPublicationLastSavedState) Sets publication last state
void	setSourceDocumentID(int value) Set the source document id associated with this scope batch master document

Method Detail

getDeliveryRuleExpression

java.lang.String getDeliveryRuleExpression()

Get Publication level delivery rule expression.

Returns:

An String containing the expression of the local delivery rule.

setDeliveryRuleExpression

void setDeliveryRuleExpression(java.lang.String deliveryRuleExpression)
                               throws SDKException

Set Publication level delivery rule expression.

Parameters:

type - A String containing local delivery rule expression.

Throws:

SDKException

isDeliverIfAlertIsTrue

boolean isDeliverIfAlertIsTrue()

Get Publication level delivery rule alert setting.

Returns:

An String containing the expression of the local delivery rule alert setting.

setDeliverIfAlertIsTrue

void setDeliverIfAlertIsTrue(boolean value)
                             throws SDKException

Set Publication level delivery rule alert setting.

Parameters:

type - A String containing local delivery rule alert setting.

Throws:

SDKException

isDeliverEmptyDocument

boolean isDeliverEmptyDocument()

Returns whether to delivery empty document.

Returns:

true if the deliver empty document, false otherwise.

setDeliverEmptyDocument

void setDeliverEmptyDocument(boolean bDeliveryEmptyDocument)

Sets the rule of whether to delivery empty document.

Parameters:

bDeliveryEmptyDocument - true if the deliver empty document, false otherwise.

getDeliverySkipped

boolean getDeliverySkipped()
                           throws SDKException

Gets the delivery skipped flag.

When processing plugins set this to true on the global delivery rule document InfoObject to specify that this publication should not be run.

Returns:

A boolean indicating whether skip delivery. Defaults to 0.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDeliverySkipped

void setDeliverySkipped(boolean bDeliverySkipped)

Sets the delivery skipped flag.

When processing plugins set this to 1 on the global delivery rule document InfoObject to specify that this publication should not be run.

Parameters:

bDeliverySkipped - An boolean indicating indicating whether skip delivery.

getDeliveryRuleResults

boolean getDeliveryRuleResults(int scopeIDWithinScopeBatch)
                               throws SDKException

Returns the delivery result for the specified scope id

DeliveryRuleResults is a PropertyBag of ( SI_SCOPE_ID, Boolean ), where the Boolean value is the recipient-level delivery rule result for recipients of specified scope on this document.

Parameters:

scopeIDWithinScopeBatch - A int represents the scope ID.

Returns:

An boolean indicating whether skip delivery.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDeliveryRuleResults

void setDeliveryRuleResults(int scopeIDWithinScopeBatch,
                            boolean bDeliverySkipped)

setDeliveryRuleResults will set the delivery boolean value for the given scope id

DeliveryRuleResults is a PropertyBag of ( SI_SCOPE_ID, Boolean ), where the Boolean value is the recipient-level delivery rule result for recipients of specified scope on this document.

Parameters:

scopeIDWithinScopeBatch - An int indicating the scope id of the current scopebatch.

bDeliverySkipped - An boolean when true means to skip delivery for the recipients of the specified scope.

removeDeliveryRuleResults

void removeDeliveryRuleResults(int scopeIDWithinScopeBatch)

Removes delivery rule results for a givenb scope.

DeliveryRuleResults is a PropertyBag of ( SI_SCOPE_ID, Boolean ), where the Boolean value is the recipient-level delivery rule result for recipients of specified scope on this document.

Parameters:

scopeIDWithinScopeBatch - An int indicating which delivery result value to be removed.

getPublicationKeepSavedData

boolean getPublicationKeepSavedData()
                                    throws SDKException

Returns the flag of publication keep saved data.

Boolean; this means that the processing plug-ins should not fetch data from the database; the InfoView/CMC code will set this on the publication instance when re-running it, and the workflow engine will set it on the scope batch document before it spawns the scope batch document job.

Returns:

An boolean indicating whether to keep saved data.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPublicationKeepSavedData

void setPublicationKeepSavedData(boolean bKeepSavedData)

Set the flag of publication keep saved data.

Boolean; this means that the processing plug-ins should not fetch data from the database; the InfoView/CMC code will set this on the publication instance when re-running it, and the workflow engine will set it on the scope batch document before it spawns the scope batch document job.

Parameters:

bKeepSavedData - An boolean indicating indicating whether skip delivery.

getPublicationLastState

long getPublicationLastState()
                             throws SDKException

Returns the publication last state.

Publication last state is used by publishing service to record the last state of the publication processing life cycle.

Returns:

An long indicating the last state.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPublicationLastState

void setPublicationLastState(long lPublicationLastSavedState)

Sets publication last state

Parameters:

lPublicationLastSavedState - An long indicating the last state of the publication processing.

getFormatInfos

IFormatInfos getFormatInfos()

Returns the multiple formats info for the publication.

Publication job servers now support exporting multiple report formats in one scheduling process. At publication design time, fill in all exported formats with their options. At publication scheduling phase, the job server will create artifacts for each requested formats.

Returns:

A IFormatInfos collection.

getScopeBatchScopes

IScopeBatchScopes getScopeBatchScopes()
                                      throws SDKException

Returns a set of scopes represented by this scope batch.

Returns:

A IScopeBatchScopes denotes the scopes in the scope batch.

Throws:

SDKException

getIsDynamicRecipientsScopeBatch

boolean getIsDynamicRecipientsScopeBatch()

Returns a boolean to indicate if this scopebatch scopes is dynamic recipients scopes.

Returns:

A boolean, true means is dynamic recipients scopes, false means BOE principals scopes

setIsDynamicRecipientsScopeBatch

void setIsDynamicRecipientsScopeBatch(boolean dynamicRecipientScopes)
                                      throws SDKException

Sets boolean value to indicate if the scopebatch scopes is dynamic recipients scopes.

Parameters:

dynamicRecipientScopes - true - Dynamic recipients scopes. false - BOE principals scopes

Throws:

SDKException

getSourceDocumentID

int getSourceDocumentID()

Returns the source document's ID associated with this scope batch master document

Returns:

An int containing the id of the source document.

setSourceDocumentID

void setSourceDocumentID(int value)
                         throws SDKException

Set the source document id associated with this scope batch master document

Parameters:

type - An int containing the id of the source document.

Throws:

SDKException