用于访问书信实例的API

概述

使用通信管理的创建通信UI，您可以保存正在处理的信件实例草稿，并且存在已提交的信件实例。

通信管理为您提供API，您可以使用这些API构建列表界面以处理已提交的信件实例或草稿。 代理的API列表和打开的提交和草稿信件实例，以便代理可以继续处理草稿或提交的信件实例。

正在获取书信实例

通信管理公开用于通过LetterInstanceService服务提取信件实例的API。

使用getAllLetterInstances

以下API根据查询对象（已提交和草稿）查找书信实例。 如果查询对象为null，则返回所有信件实例。 此API返回列表 LetterInstanceVO 对象，可用于提取信件实例的附加信息。

语法： List getAllLetterInstances(Query query) throws ICCException;

示例1：提取SUBMITTED类型的所有信件实例

以下代码返回已提交书信实例的列表。 要仅获取草稿，请更改 LetterInstanceType.COMPLETE.name() 到 LetterInstanceType.DRAFT.name().

@Reference
LetterInstanceService letterInstanceService;
Query query = new Query();

List<LetterInstanceVO> submittedLetterInstances = new ArrayList<LetterInstanceVO>();

Statement statementForInstanceType = new Statement();
statementForInstanceType.setAttributeName("letterInstanceType");
statementForInstanceType.setOperator(Operator.EQUALS);
statementForInstanceType.setAttributeValue(LetterInstanceType.COMPLETE.name());
query.addStatement(statementForInstanceType);
submittedLetterInstances = letterInstanceService.getAllLetterInstances(query);

示例2：提取用户提交的所有信件实例，信件实例类型为“草稿”

以下代码在同一查询中有多个语句，用于获取根据不同的条件过滤的结果，例如用户提交的信件实例（属性提交者）以及letterInstanceType类型为DRAFT。

@Reference
LetterInstanceService letterInstanceService;

String submittedBy = "tglodman";
Query query = new Query();

List<LetterInstanceVO> submittedLetterInstances = new ArrayList<LetterInstanceVO>();

Statement statementForInstanceType = new Statement();
statementForInstanceType.setAttributeName("letterInstanceType");
statementForInstanceType.setOperator(Operator.EQUALS);
statementForInstanceType.setAttributeValue(LetterInstanceType.COMPLETE.name());
query.addStatement(statementForInstanceType);

Statement statementForSubmittedBy = new Statement();
statementForSubmittedBy .setAttributeName("submittedby");
statementForSubmittedBy .setOperator(Operator.EQUALS);
statementForSubmittedBy .setAttributeValue(submittedBy);
query.addStatement(statementForSubmittedBy );
submittedLetterInstances = letterInstanceService.getAllLetterInstances(query);

使用getLetterInstance

获取由给定的书信实例ID标识的书信实例。 如果实例ID不匹配，则返回“ null ”。

语法： public LetterInstanceVO getLetterInstance(String letterInstanceId) throws ICCException;

@Reference
LetterInstanceService letterInstanceService;
String letterInstanceId = "/content/apps/cm/letterInstances/1001/sampleLetterInstance";
LetterInstanceVO letterInstance = letterInstanceService.getLetterInstance(letterInstanceId );

正在验证LetterInstance是否存在

检查是否存在具有给定名称的书信实例

语法： public Boolean letterInstanceExists(String letterInstanceName) throws ICCException;

@Reference
LetterInstanceService letterInstanceService;
String letterInstanceName = "sampleLetterInstance";
Boolean result = letterInstanceService.letterInstanceExists(letterInstanceName );

打开书信实例

书信实例可以是已提交或草稿类型。 打开两种信件实例类型时，会显示不同的行为：

• 如果存在已提交信件实例，则会打开表示该信件实例的PDF。 服务器上保留的提交的书信实例还包含dataXML和已处理的XDP，这可用于完成并进一步自定义用例，如创建PDF/A。
• 如果存在草稿信件实例，则创建通信UI将重新加载到与创建草稿时完全相同的先前状态

打开草稿信件实例 

CCR UI支持cmLetterInstanceId参数，该参数可用于重新加载书信。

https://[hostName]:[portNo]/[contextPath]//aem/forms/createcorrespondence.html?random=[randomNo]&cmLetterInstanceId=[letterInstanceId]

打开已提交的书信实例

可以使用书信实例ID直接打开提交的PDF：

https://[hostName]:[portNo]/[contextPath]/[letterInstanceId]