Show Menu
主题×

用于访问字母实例的API

概述

使用Correate Management的“创建对应UI”,您可以在进行中保存字母实例的草稿,并且存在已提交的字母实例。
通信管理为您提供了API,您可以使用这些API构建列表界面以处理提交的信函实例或草稿。 API列出并打开代理的已提交和草稿字母实例,以便代理可以继续处理草稿或已提交的字母实例。

获取字母实例

Correponce Management公开API以通过LetterInstanceService服务获取字母实例。
方法
描述
getAllLetterInstances
根据输入查询参数获取字母实例。 要获取所有字母实例,请将查询参数作为null传递。
getLetterInstance
根据字母实例Id获取指定的字母实例。
letterInstanceExists
检查LetterInstance是否按给定名称存在。
LetterInstanceService是OSGI服务,它的实例可通过在Java中使用@Reference来检索 Class或sling.getService(LetterInstanceService)。 类)。

使用getAllLetterInstances

以下API根据查询对象(已提交和草稿)查找字母实例。 如果查询对象为null,则返回所有字母实例。 此API返回 LetterInstanceVO对象列表 ,该列表可用于提取字母实例的其他信息
语法 : List getAllLetterInstances(Query query) throws ICCException;
参数 描述
查询 查询参数用于查找/过滤Letter实例。 此处查询仅支持对象的顶级属性/属性。 查询由语句组成,Statement对象中使用的“attributeName”应为Letter实例对象中属性的名称。

示例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:提取用户提交的所有字母实例,并且字母实例类型为DRAFT

以下代码在同一查询中有多个语句,以根据用户提交的字母实例(属性提交者)等不同条件筛选结果,并且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;
参数
描述
letterInstanceName
要检查其是否存在的字母实例的名称。
@Reference
LetterInstanceService letterInstanceService;
String letterInstanceName = "sampleLetterInstance";
Boolean result = letterInstanceService.letterInstanceExists(letterInstanceName );

开始字母实例

Letter Instance的类型可以是“已提交”或“草稿”。 打开两个字母实例类型会显示不同的行为:
  • 对于“已提交的字母实例”,将打开表示字母实例的PDF。 在服务器上保留的已提交书信实例还包含dataXML和已处理的XDP,它可用于完成和进一步自定义用例,如创建PDF/A。
  • 对于Draft字母实例,创建对应UI将重新加载到与创建Draft时相同的上一状态

打开草稿字母实例

CCR UI支持cmLetterInstanceId参数,该参数可用于重新加载字母。
https://[hostName]:[portNo]/[contextPath]//aem/forms/createcorrespondence.html?random=[randomNo]&cmLetterInstanceId=[letterInstanceId]
重新加载通信时,不必指定cmLetterId或cmLetterName/State/Version,因为提交的数据已经包含有关重新加载的通信的所有详细信息。 RandomNo用于避免浏览器缓存问题,您可以使用时间戳作为随机数。

正在开始提交的信函实例

提交的PDF可以使用字母实例Id直接打开:
https://[hostName]:[portNo]/[contextPath]/[letterInstanceId]