com.adobe.icc.services.api
Interface ACMConfigurationService

public interface ACMConfigurationService

Service interface for ACM configuration.

Method Summary

java.lang.Integer	getApplicationTimeOut() Returns Application Time Out in seconds.
java.lang.Double	getArabicMinWidth() Returns minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.
java.lang.String	getAttachmentDocsParamName()
java.lang.String	getCMUserRoot()
java.lang.String	getContentColor() Returns Content Highlight Color in Create Correspondence UI (RGB format).
java.lang.String	getContentHighlightType() Returns Content Highlight Type in Create Correspondence UI.
LocalizedDataFormatInfo	getDataEditFormatInfo() Returns system wide data edit formatting information that should be used when parsing data from string or formatting data to string.
java.lang.String	getFieldColor() Returns Field Highlight Color in Create Correspondence UI (RGB format).
java.lang.String	getFieldHighlightType() Returns Field Highlight Type in Create Correspondence UI.
java.lang.Double	getIndent() Returns the indentation value.
java.util.List	getLocalizedDataDisplayFormats() List of data formatting informations for various locales.
java.lang.String	getPdfDocParamName() Returns parameter name for PDF document sent to the post process.
java.lang.String	getPdfformAcrobatVersion() Returns PDF Form Acrobat Version.
java.lang.String	getPrintpdfAcrobatVersion() Returns Non-interactive PDF Acorbat Version.
java.lang.Double	getRomanMiWidth() Returns minimum width to be applied on the bullet/number field, when using Roman numbers.
java.lang.String	getSubmitPdfType() Returns type of PDF submitted to the post process, for example interactive or non-interactive.
java.lang.String	getTargetColor() Returns Target Highlight Color in Create Correspondence UI (RGB format).
java.lang.String	getTargetHighlightType() Returns Target Highlight Type in Create Correspondence UI.
java.lang.String	getUrlParamName() Returns parameter name for the redirect URL sent from the post process.
java.lang.String	getXdpDocParamName() Returns parameter name for XDP document sent to the post process.
java.lang.String	getXmlDocParamName() Returns parameter name for XML data sent to the post process.
boolean	isAutoCorrectAssets() Returns whether the functionality of auto correcting inconsistencies of Asset Assignments is enabled
boolean	isEnableAudit()
boolean	isEnableCCRPDFHighlight() Returns if PDF Highlight in Create Correspondence UI should be enabled
boolean	isEnableCreateAudit()
boolean	isEnableCustomDeliveryAudit()
boolean	isEnableEmailAudit()
boolean	isEnablePrintAudit()
boolean	isEnablePublishAudit()
boolean	isEnablePush() Returns whether push functionality in Asset Composer Building Block enabled.
boolean	isEnableReadAudit()
boolean	isEnableRevertAudit()
boolean	isEnableSaveAsDraftAudit()
boolean	isEnableSubmitAudit()
boolean	isEnableUpdateAudit()
boolean	isManageLetterInstances()
boolean	isOptimizeDDI()
boolean	isPdfformCacheEnabled() Returns whether the PDF Form is Cache Enabled.
boolean	isPdfformDebugEnabled() Returns whether the PDF Form Debug Enabled.
boolean	isPrintpdfCacheEnabled() Returns whether Non-interactive PDF Cache is Enabled.
boolean	isPrintpdfDebugEnabled() Returns whether Non-interactive PDF Debug Enabled.
boolean	isUseDataFormatConfiguration() gets flag indicating whether the data edit and display formatting configurations be used.
void	setApplicationTimeOut(java.lang.Integer applicationTimeOut) Sets Application Time Out in seconds.
void	setArabicMinWidth(java.lang.Double arabicMinWidth) Sets minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.
void	setAttachmentDocsParamName(java.lang.String attachmentDocsParamName)
void	setAutoCorrectAssets(boolean autoCorrectAssets) Sets flag which is used to enable/disable the functionality of auto correcting inconsistencies of Asset Assignments
void	setCMUserRoot(java.lang.String cmUserRoot)
void	setContentColor(java.lang.String contentColor) Sets Content Highlight Color in Create Correspondence UI (RGB format).
void	setContentHighlightType(java.lang.String contentHighlightType) Sets Content Highlight Type in Create Correspondence UI.
void	setEnableAudit(boolean enableAudit)
void	setEnableCCRPDFHighlight(boolean enableCCRPDFHighlight) Sets whether PDF Highlight in Create Correspondence UI should be enabled
void	setEnableCreateAudit(boolean enableCreateAudit)
void	setEnableCustomDeliveryAudit(boolean enableCustomDeliveryAudit)
void	setEnableEmailAudit(boolean enableEmailAudit)
void	setEnablePrintAudit(boolean enablePrintAudit)
void	setEnablePublishAudit(boolean enablePublishAudit)
void	setEnablePush(boolean enablePush) Sets flag indicating whether push functionality in Asset Composer Building Block is enabled.
void	setEnableReadAudit(boolean enableReadAudit)
void	setEnableRevertAudit(boolean enableRevertAudit)
void	setEnableSaveAsDraftAudit(boolean enableSaveAsDraftAudit)
void	setEnableSubmitAudit(boolean enableSubmitAudit)
void	setEnableUpdateAudit(boolean enableUpdateAudit)
void	setFieldColor(java.lang.String fieldColor) Sets Field Highlight Color in Create Correspondence UI (RGB format).
void	setFieldHighlightType(java.lang.String fieldHighlightType) Sets Field Highlight Type in Create Correspondence UI.
void	setIndent(java.lang.Double indent) Sets the indentation value.
void	setManageLetterInstances(boolean manageLetterInstances)
void	setOptimizeDDI(boolean optimizeDDI)
void	setPdfDocParamName(java.lang.String pdfDocParamName) Sets parameter name for PDF document sent to the post process.
void	setPdfformAcrobatVersion(java.lang.String pdfformAcrobatVersion) Sets PDF Form Acrobat Version.
void	setPdfformCacheEnabled(boolean pdfformCacheEnabled) Sets flag indicating whether the PDF Form is Cache Enabled.
void	setPdfformDebugEnabled(boolean pdfformDebugEnabled) Sets flag indicating whether the PDF Form Debug Enabled.
void	setPrintpdfAcrobatVersion(java.lang.String printpdfAcrobatVersion) Sets Non-interactive PDF Acorbat Version.
void	setPrintpdfCacheEnabled(boolean printpdfCacheEnabled) Sets flag indicating whether Non-interactive PDF Cache is Enabled.
void	setPrintpdfDebugEnabled(boolean printpdfDebugEnabled) Sets flag indicating whether Non-interactive PDF Debug Enabled.
void	setRomanMiWidth(java.lang.Double romanMiWidth) Sets minimum width to be applied on the bullet/number field, when using Roman numbers.
void	setSubmitPdfType(java.lang.String submitPdfType) Sets type of PDF submitted to the post process, for example interactive or non-interactive.
void	setTargetColor(java.lang.String targetColor) Sets Target Highlight Color in Create Correspondence UI (RGB format).
void	setTargetHighlightType(java.lang.String targetHighlightType) Sets Target Highlight Type in Create Correspondence UI.
void	setUrlParamName(java.lang.String urlParamName) Sets parameter name for the redirect URL sent from the post process.
void	setUseDataFormatConfiguration(boolean useDataFormatConfiguration) Sets flag indicating whether the data edit and display formatting configurations be used.
void	setXdpDocParamName(java.lang.String xdpDocParamName) Sets parameter name for XDP document sent to the post process.
void	setXmlDocParamName(java.lang.String xmlDocParamName) Sets parameter name for XML data sent to the post process.

Method Detail

getIndent

java.lang.Double getIndent()

Returns the indentation value.

Returns:

indentation value.

setIndent

void setIndent(java.lang.Double indent)

Sets the indentation value.

Parameters:

indent - indentation value.

getArabicMinWidth

java.lang.Double getArabicMinWidth()

Returns minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.

Returns:

minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.

setArabicMinWidth

void setArabicMinWidth(java.lang.Double arabicMinWidth)

Sets minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.

Parameters:

arabicMinWidth - minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers.

getRomanMiWidth

java.lang.Double getRomanMiWidth()

Returns minimum width to be applied on the bullet/number field, when using Roman numbers.

Returns:

minimum width to be applied on the bullet/number field, when using Roman numbers.

setRomanMiWidth

void setRomanMiWidth(java.lang.Double romanMiWidth)

Sets minimum width to be applied on the bullet/number field, when using Roman numbers.

Parameters:

romanMiWidth - minimum width to be applied on the bullet/number field, when using Roman numbers.

isEnableCCRPDFHighlight

boolean isEnableCCRPDFHighlight()

Returns if PDF Highlight in Create Correspondence UI should be enabled

Returns:

whether PDF Highlight in Create Correspondence UI should be enabled

setEnableCCRPDFHighlight

void setEnableCCRPDFHighlight(boolean enableCCRPDFHighlight)

Sets whether PDF Highlight in Create Correspondence UI should be enabled

Parameters:

enableCCRPDFHighlight -

getTargetHighlightType

java.lang.String getTargetHighlightType()

Returns Target Highlight Type in Create Correspondence UI.

Returns:

Target Highlight Type in Create Correspondence UI.

setTargetHighlightType

void setTargetHighlightType(java.lang.String targetHighlightType)

Sets Target Highlight Type in Create Correspondence UI.

Parameters:

targetHighlightType - Target Highlight Type in Create Correspondence UI.

getTargetColor

java.lang.String getTargetColor()

Returns Target Highlight Color in Create Correspondence UI (RGB format).

Returns:

Target Highlight Color in Create Correspondence UI (RGB format).

setTargetColor

void setTargetColor(java.lang.String targetColor)

Sets Target Highlight Color in Create Correspondence UI (RGB format).

Parameters:

targetColor - Target Highlight Color in Create Correspondence UI (RGB format).

getContentHighlightType

java.lang.String getContentHighlightType()

Returns Content Highlight Type in Create Correspondence UI.

Returns:

Content Highlight Type in Create Correspondence UI.

setContentHighlightType

void setContentHighlightType(java.lang.String contentHighlightType)

Sets Content Highlight Type in Create Correspondence UI.

Parameters:

contentHighlightType - Content Highlight Type in Create Correspondence UI.

getContentColor

java.lang.String getContentColor()

Returns Content Highlight Color in Create Correspondence UI (RGB format).

Returns:

Content Highlight Color in Create Correspondence UI (RGB format).

setContentColor

void setContentColor(java.lang.String contentColor)

Sets Content Highlight Color in Create Correspondence UI (RGB format).

Parameters:

contentColor - Content Highlight Color in Create Correspondence UI (RGB format).

getFieldHighlightType

java.lang.String getFieldHighlightType()

Returns Field Highlight Type in Create Correspondence UI.

Returns:

Field Highlight Type in Create Correspondence UI.

setFieldHighlightType

void setFieldHighlightType(java.lang.String fieldHighlightType)

Sets Field Highlight Type in Create Correspondence UI.

Parameters:

fieldHighlightType - Field Highlight Type in Create Correspondence UI.

getFieldColor

java.lang.String getFieldColor()

Returns Field Highlight Color in Create Correspondence UI (RGB format).

Returns:

Field Highlight Color in Create Correspondence UI (RGB format).

setFieldColor

void setFieldColor(java.lang.String fieldColor)

Sets Field Highlight Color in Create Correspondence UI (RGB format).

Parameters:

fieldColor - Field Highlight Color in Create Correspondence UI (RGB format).

isPdfformCacheEnabled

boolean isPdfformCacheEnabled()

Returns whether the PDF Form is Cache Enabled.

Returns:

whether the PDF Form is Cache Enabled.

setPdfformCacheEnabled

void setPdfformCacheEnabled(boolean pdfformCacheEnabled)

Sets flag indicating whether the PDF Form is Cache Enabled.

Parameters:

pdfformCacheEnabled - flag indicating whether the PDF Form is Cache Enabled.

isPdfformDebugEnabled

boolean isPdfformDebugEnabled()

Returns whether the PDF Form Debug Enabled.

Returns:

whether the PDF Form Debug Enabled.

setPdfformDebugEnabled

void setPdfformDebugEnabled(boolean pdfformDebugEnabled)

Sets flag indicating whether the PDF Form Debug Enabled.

Parameters:

pdfformDebugEnabled - flag indicating whether the PDF Form Debug Enabled.

getPdfformAcrobatVersion

java.lang.String getPdfformAcrobatVersion()

Returns PDF Form Acrobat Version.

Returns:

PDF Form Acrobat Version.

setPdfformAcrobatVersion

void setPdfformAcrobatVersion(java.lang.String pdfformAcrobatVersion)

Sets PDF Form Acrobat Version.

Parameters:

pdfformAcrobatVersion - PDF Form Acrobat Version.

isPrintpdfCacheEnabled

boolean isPrintpdfCacheEnabled()

Returns whether Non-interactive PDF Cache is Enabled.

Returns:

whether Non-interactive PDF Cache is Enabled.

setPrintpdfCacheEnabled

void setPrintpdfCacheEnabled(boolean printpdfCacheEnabled)

Sets flag indicating whether Non-interactive PDF Cache is Enabled.

Parameters:

printpdfCacheEnabled - flag indicating whether Non-interactive PDF Cache is Enabled.

isPrintpdfDebugEnabled

boolean isPrintpdfDebugEnabled()

Returns whether Non-interactive PDF Debug Enabled.

Returns:

whether Non-interactive PDF Debug Enabled.

setPrintpdfDebugEnabled

void setPrintpdfDebugEnabled(boolean printpdfDebugEnabled)

Sets flag indicating whether Non-interactive PDF Debug Enabled.

Parameters:

printpdfDebugEnabled - flag indicating whether Non-interactive PDF Debug Enabled.

getPrintpdfAcrobatVersion

java.lang.String getPrintpdfAcrobatVersion()

Returns Non-interactive PDF Acorbat Version.

Returns:

Non-interactive PDF Acorbat Version.

setPrintpdfAcrobatVersion

void setPrintpdfAcrobatVersion(java.lang.String printpdfAcrobatVersion)

Sets Non-interactive PDF Acorbat Version.

Parameters:

printpdfAcrobatVersion - Non-interactive PDF Acorbat Version.

getApplicationTimeOut

java.lang.Integer getApplicationTimeOut()

Returns Application Time Out in seconds.

Returns:

Application Time Out in seconds.

setApplicationTimeOut

void setApplicationTimeOut(java.lang.Integer applicationTimeOut)

Sets Application Time Out in seconds.

Parameters:

applicationTimeOut - Application Time Out in seconds.

getPdfDocParamName

java.lang.String getPdfDocParamName()

Returns parameter name for PDF document sent to the post process.

Returns:

parameter name for PDF document sent to the post process.

setPdfDocParamName

void setPdfDocParamName(java.lang.String pdfDocParamName)

Sets parameter name for PDF document sent to the post process.

Parameters:

pdfDocParamName - parameter name for PDF document sent to the post process.

getXmlDocParamName

java.lang.String getXmlDocParamName()

Returns parameter name for XML data sent to the post process.

Returns:

parameter name for XML data sent to the post process.

setXmlDocParamName

void setXmlDocParamName(java.lang.String xmlDocParamName)

Sets parameter name for XML data sent to the post process.

Parameters:

xmlDocParamName - parameter name for XML data sent to the post process.

getXdpDocParamName

java.lang.String getXdpDocParamName()

Returns parameter name for XDP document sent to the post process.

Returns:

parameter name for XDP document sent to the post process.

setXdpDocParamName

void setXdpDocParamName(java.lang.String xdpDocParamName)

Sets parameter name for XDP document sent to the post process.

Parameters:

xdpDocParamName - parameter name for XDP document sent to the post process.

getUrlParamName

java.lang.String getUrlParamName()

Returns parameter name for the redirect URL sent from the post process.

Returns:

parameter name for the redirect URL sent from the post process.

setUrlParamName

void setUrlParamName(java.lang.String urlParamName)

Sets parameter name for the redirect URL sent from the post process.

Parameters:

urlParamName - parameter name for the redirect URL sent from the post process.

getSubmitPdfType

java.lang.String getSubmitPdfType()

Returns type of PDF submitted to the post process, for example interactive or non-interactive.

Returns:

type of PDF submitted to the post process.

setSubmitPdfType

void setSubmitPdfType(java.lang.String submitPdfType)

Sets type of PDF submitted to the post process, for example interactive or non-interactive.

Parameters:

submitPdfType - type of PDF submitted to the post process.

isOptimizeDDI

boolean isOptimizeDDI()

setOptimizeDDI

void setOptimizeDDI(boolean optimizeDDI)

isEnablePush

boolean isEnablePush()

Returns whether push functionality in Asset Composer Building Block enabled.

Returns:

whether push functionality in Asset Composer Building Block enabled.

setEnablePush

void setEnablePush(boolean enablePush)

Sets flag indicating whether push functionality in Asset Composer Building Block is enabled.

Parameters:

enablePush - flag indicating whether push functionality in Asset Composer Building Block is enabled.

isAutoCorrectAssets

boolean isAutoCorrectAssets()

Returns whether the functionality of auto correcting inconsistencies of Asset Assignments is enabled

Returns:

whether the functionality of auto correcting inconsistencies of Asset Assignments is enabled

setAutoCorrectAssets

void setAutoCorrectAssets(boolean autoCorrectAssets)

Sets flag which is used to enable/disable the functionality of auto correcting inconsistencies of Asset Assignments

Parameters:

whether - the functionality of auto correcting inconsistencies of Asset Assignments is enabled

getDataEditFormatInfo

LocalizedDataFormatInfo getDataEditFormatInfo()

Returns system wide data edit formatting information that should be used when parsing data from string or formatting data to string.

Returns:

data edit format info object.

getLocalizedDataDisplayFormats

java.util.List getLocalizedDataDisplayFormats()

List of data formatting informations for various locales. This is used for while displaying data on Ui

Returns:

list of data display formats

isUseDataFormatConfiguration

boolean isUseDataFormatConfiguration()

gets flag indicating whether the data edit and display formatting configurations be used.

Returns:

flag indicating whether the data edit and display formatting configurations be used

setUseDataFormatConfiguration

void setUseDataFormatConfiguration(boolean useDataFormatConfiguration)

Sets flag indicating whether the data edit and display formatting configurations be used.

Parameters:

useDataFormatConfiguration - flag indicating whether the data edit and display formatting configurations be used

isManageLetterInstances

boolean isManageLetterInstances()

Returns:

whether the letter management functionality is enabled or disabled.

setManageLetterInstances

void setManageLetterInstances(boolean manageLetterInstances)

Parameters:

manageLetters - enables/disables the letter management functionality.

isEnableAudit

boolean isEnableAudit()

setEnableAudit

void setEnableAudit(boolean enableAudit)

isEnableReadAudit

boolean isEnableReadAudit()

setEnableReadAudit

void setEnableReadAudit(boolean enableReadAudit)

isEnableCreateAudit

boolean isEnableCreateAudit()

setEnableCreateAudit

void setEnableCreateAudit(boolean enableCreateAudit)

isEnableUpdateAudit

boolean isEnableUpdateAudit()

setEnableUpdateAudit

void setEnableUpdateAudit(boolean enableUpdateAudit)

isEnableRevertAudit

boolean isEnableRevertAudit()

setEnableRevertAudit

void setEnableRevertAudit(boolean enableRevertAudit)

isEnablePublishAudit

boolean isEnablePublishAudit()

setEnablePublishAudit

void setEnablePublishAudit(boolean enablePublishAudit)

isEnableSaveAsDraftAudit

boolean isEnableSaveAsDraftAudit()

setEnableSaveAsDraftAudit

void setEnableSaveAsDraftAudit(boolean enableSaveAsDraftAudit)

isEnableSubmitAudit

boolean isEnableSubmitAudit()

setEnableSubmitAudit

void setEnableSubmitAudit(boolean enableSubmitAudit)

isEnableEmailAudit

boolean isEnableEmailAudit()

setEnableEmailAudit

void setEnableEmailAudit(boolean enableEmailAudit)

isEnablePrintAudit

boolean isEnablePrintAudit()

setEnablePrintAudit

void setEnablePrintAudit(boolean enablePrintAudit)

isEnableCustomDeliveryAudit

boolean isEnableCustomDeliveryAudit()

setEnableCustomDeliveryAudit

void setEnableCustomDeliveryAudit(boolean enableCustomDeliveryAudit)

getAttachmentDocsParamName

java.lang.String getAttachmentDocsParamName()

setAttachmentDocsParamName

void setAttachmentDocsParamName(java.lang.String attachmentDocsParamName)

getCMUserRoot

java.lang.String getCMUserRoot()

setCMUserRoot

void setCMUserRoot(java.lang.String cmUserRoot)