편지 인스턴스에 액세스할 수 있는 API apis-to-access-letter-instances

개요 overview

서신 관리의 서신 UI 만들기를 사용하여 진행 중인 서신 인스턴스의 초안을 저장할 수 있으며 제출된 편지 인스턴스가 있습니다.

Correspondence Management는 제출된 편지 인스턴스 또는 초안에서 작업할 수 있도록 목록 인터페이스를 구축할 수 있는 를 사용하는 API를 제공합니다. API 목록 및 열린 에이전트의 제출 및 초안 편지 인스턴스로 인해 에이전트가 초안 또는 제출된 편지 인스턴스에서 계속 작업할 수 있습니다.

편지 인스턴스 가져오기 fetching-letter-instances

서신 관리는 LetterInstanceService 서비스를 통해 편지 인스턴스를 가져오도록 API를 표시합니다.

getAllLetterInstances 사용 using-nbsp-getallletterinstances

다음 API는 쿼리 개체(제출됨 및 초안 모두)를 기반으로 편지 인스턴스를 찾습니다. 쿼리 개체가 null이면 모든 편지 인스턴스를 반환합니다. 이 API는 LetterInstanceVO 문자 인스턴스의 추가 정보를 추출하는 데 사용할 수 있는 객체

구문: List getAllLetterInstances(Query query) throws ICCException;

예제 1: SUBMITTED 유형의 모든 편지 인스턴스 가져오기 example-fetch-all-the-letter-instances-of-type-submitted

다음 코드는 제출된 편지 인스턴스 목록을 반환합니다. 초안만 가져오려면 LetterInstanceType.COMPLETE.name() to 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입니다 example-nbsp-fetch-all-the-letter-instances-submitted-by-a-user-and-letter-instance-type-is-draft

다음 코드에는 사용자가 제출한 편지 인스턴스(Attribute submittedby)와 같은 다른 기준에 따라 필터링된 결과를 얻기 위해 동일한 쿼리에 여러 개의 문이 있으며 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 사용 using-nbsp-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가 있는지 확인 verifying-if-letterinstance-exist

Letter 인스턴스가 지정된 이름으로 존재하는지 확인합니다.

구문: public Boolean letterInstanceExists(String letterInstanceName) throws ICCException;

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

편지 인스턴스 열기 opening-letter-instances

편지 인스턴스는 제출됨 또는 초안 유형일 수 있습니다. 두 문자 인스턴스 유형을 모두 열면 다른 동작이 표시됩니다.

초안 편지 인스턴스 열기  opening-draft-letter-instance-nbsp

CCR UI는 문자를 다시 로드하는 데 사용할 수 있는 cmLetterInstanceId 매개 변수를 지원합니다.

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

제출된 편지 인스턴스 열기 opening-submitted-letter-instance

제출된 PDF은 문자 인스턴스 ID를 사용하여 직접 열 수 있습니다.

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