com.adobe.icc.services.api

Interface LetterInstanceService

Deprecated.

@Deprecated
public interface LetterInstanceService

Service interface for LetterInstanceVO specific operations. It provides create, read and delete operations on various instances of Letter. Instance of letter can be of two types viz. Drafts or Submitted

Method Summary

Modifier and Type	Method and Description
void	deleteLetterInstance(String letterInstanceId) Deprecated.
List<LetterInstanceVO>	getAllLetterInstances(Query query) Deprecated.
LetterInstanceVO	getLetterInstance(String letterInstanceId) Deprecated.
Boolean	letterInstanceExists(String letterInstanceName) Deprecated.
LetterInstanceVO	readLetterInstance(String letterInstanceId) Deprecated.
LetterInstanceVO	saveAsDraft(Letter letter, byte[] XMLData, String letterInstanceName) Deprecated.
LetterInstanceVO	saveSubmittedLetter(Letter letter, byte[] PDFBytes, byte[] processedXDP, byte[] dataXML, String letterInstanceName) Deprecated.
LetterInstanceVO	saveSubmittedLetter(Letter letter, byte[] PDFBytes, byte[] processedXDP, byte[] dataXML, String letterInstanceName, byte[] adMergedJson, String adNodePath) Deprecated.

Method Detail

saveSubmittedLetter

@Deprecated
LetterInstanceVO saveSubmittedLetter(Letter letter,
                                                 byte[] PDFBytes,
                                                 byte[] processedXDP,
                                                 byte[] dataXML,
                                                 String letterInstanceName)
                                          throws ICCException

Deprecated.

Saves a submitted instance of a letter given various required inputs

Parameters:

letter - Letter object representing letter whose instance is to be saved

PDFBytes - bytes representing the generated PDF for the letter instance

processedXDP - bytes representing the processed XDP for the letter instance

dataXML - bytes representing the data for the letter instance

letterInstanceName - name of the letter instance to be saved

Returns:

A LetterInstanceVO object representing the saved submitted instance of letter

Throws:

ICCException

saveSubmittedLetter

@Deprecated
LetterInstanceVO saveSubmittedLetter(Letter letter,
                                                 byte[] PDFBytes,
                                                 byte[] processedXDP,
                                                 byte[] dataXML,
                                                 String letterInstanceName,
                                                 byte[] adMergedJson,
                                                 String adNodePath)
                                          throws ICCException

Deprecated.

Saves a submitted instance of a letter given various required inputs. This api is specific for saving submitted instance of adaptive documents based on letter.

Parameters:

letter - Letter object representing letter whose instance is to be saved

PDFBytes - bytes representing the generated PDF for the letter instance

processedXDP - bytes representing the processed XDP for the letter instance

dataXML - bytes representing the data for the letter instance

letterInstanceName - name of the letter instance to be saved

adMergedJson - Merged Json for the adaptive document

adNodePath - Path for the adaptive document based on this letter

Returns:

A LetterInstanceVO object representing the saved submitted instance of letter

Throws:

ICCException

saveAsDraft

@Deprecated
LetterInstanceVO saveAsDraft(Letter letter,
                                         byte[] XMLData,
                                         String letterInstanceName)
                                  throws ICCException

Deprecated.

Saves a draft instance of a letter

Parameters:

letter - Letter object representing letter whose instance is to be saved

XMLData - bytes representing the data for the letter instance

letterInstanceName - name of the letter instance to be saved

Returns:

A LetterInstanceVO object representing the saved draft instance of letter

Throws:

ICCException

getLetterInstance

@Deprecated
LetterInstanceVO getLetterInstance(String letterInstanceId)
                                        throws ICCException

Deprecated.

Gets a particular letter instance. This action is not audited for action type Read.

Parameters:

letterInstanceId - id of the letter instance to be read

Returns:

A LetterInstanceVO object representing the read instance of letter

Throws:

ICCException

readLetterInstance

@Deprecated
LetterInstanceVO readLetterInstance(String letterInstanceId)
                                         throws ICCException

Deprecated.

Gets a particular letter instance. This action is audited for action type Read.

Parameters:

letterInstanceId - id of the letter instance to be read

Returns:

A LetterInstanceVO object representing the read instance of letter

Throws:

ICCException

deleteLetterInstance

@Deprecated
void deleteLetterInstance(String letterInstanceId)
                               throws ICCException

Deprecated.

Delete the letter instance indentified by the Id

Parameters:

letterInstanceId - id of the letter instance to be deleted

Throws:

ICCException

letterInstanceExists

@Deprecated
Boolean letterInstanceExists(String letterInstanceName)
                                  throws ICCException

Deprecated.

Check if a LetterInstanceVO exists by the given name.

Parameters:

letterInstanceName - Name of the LetterInstanceVO.

Returns:

true if exists, false otherwise.

Throws:

ICCException

getAllLetterInstances

@Deprecated
List<LetterInstanceVO> getAllLetterInstances(Query query)
                                                  throws ICCException

Deprecated.

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