com.adobe.icc.services.api
Interface LetterInstanceService

public interface LetterInstanceService

Service interface for specific operations.

Method Summary

LetterInstanceVO	appendToActionLog(java.lang.String letterInstanceId, java.lang.String action)
void	deleteLetterInstance(java.lang.String letterInstanceId)
java.util.List	getAllLetterInstances(Query query) List all LetterInstanceVOs filtered by the given Query.
LetterInstanceVO	getLetterInstance(java.lang.String letterInstanceId)
java.lang.Boolean	letterInstanceExists(java.lang.String letterInstanceName) Check if a LetterInstanceVO exists by the given name.
LetterInstanceVO	readLetterInstance(java.lang.String letterInstanceId)
LetterInstanceVO	saveAsDraft(Letter letter, byte[] XMLData, java.lang.String letterInstanceName)
LetterInstanceVO	saveSubmittedLetter(Letter letter, byte[] PDFBytes, byte[] processedXDP, byte[] dataXML, java.lang.String letterInstanceName)
LetterInstanceVO	updateAccessGroups(java.lang.String letterInstanceId, java.util.List accessGroups)

Method Detail

saveSubmittedLetter

LetterInstanceVO saveSubmittedLetter(Letter letter,
                                     byte[] PDFBytes,
                                     byte[] processedXDP,
                                     byte[] dataXML,
                                     java.lang.String letterInstanceName)
                                     throws ICCException

Throws:

ICCException

saveAsDraft

LetterInstanceVO saveAsDraft(Letter letter,
                             byte[] XMLData,
                             java.lang.String letterInstanceName)
                             throws ICCException

Throws:

ICCException

getLetterInstance

LetterInstanceVO getLetterInstance(java.lang.String letterInstanceId)
                                   throws ICCException

Throws:

ICCException

readLetterInstance

LetterInstanceVO readLetterInstance(java.lang.String letterInstanceId)
                                    throws ICCException

Throws:

ICCException

appendToActionLog

LetterInstanceVO appendToActionLog(java.lang.String letterInstanceId,
                                   java.lang.String action)
                                   throws ICCException

Throws:

ICCException

deleteLetterInstance

void deleteLetterInstance(java.lang.String letterInstanceId)
                          throws ICCException

Throws:

ICCException

updateAccessGroups

LetterInstanceVO updateAccessGroups(java.lang.String letterInstanceId,
                                    java.util.List accessGroups)
                                    throws ICCException

Throws:

ICCException

letterInstanceExists

java.lang.Boolean letterInstanceExists(java.lang.String letterInstanceName)
                                       throws ICCException

Check if a LetterInstanceVO exists by the given name.

Parameters:

letterInstanceName - Name of the LetterInstanceVO.

Returns:

true if exists, false otherwise.

Throws:

ICCException

getAllLetterInstances

java.util.List getAllLetterInstances(Query query)
                                     throws ICCException

List all LetterInstanceVOs filtered by the given Query.

Parameters:

query - Query to select Letter (supports only first level attributes/properties of an object).
The "attributeName" used in the Statement object should be the name of the property in the object (Form object, in this case).

Returns:

List of Letter objects

Throws:

ICCException

See Also:

Statement, Query