com.adobe.icc.services.api

Interface LetterService

Deprecated.

@Deprecated
public interface LetterService

Service interface for Letter specific operations like create, update, copy, etc.

Method Summary

Modifier and Type	Method and Description
Letter	activateLetter(String letterID, boolean updateDependencies) Deprecated. Use PublishService.publishAssets(List) instead
Letter	copyLetter(String oldletterID, Letter newletter) Deprecated.
Letter	createLetter(Letter letter) Deprecated.
Letter	createLetterAndForm(Letter letter) Deprecated.
Letter	createTestLetter(String letterID) Deprecated.
List<Letter>	getAllLetters(Query query) Deprecated.
List<Letter>	getAllLetters(Query query, String cutPoints) Deprecated.
Letter	getLetter(String letterID) Deprecated.
Letter	getLetter(String letterID, boolean includedContent) Deprecated.
Map<String,List>	getLetterDataElements(String letterID) Deprecated.
Letter	getLetterWithLatestAssets(String letterID) Deprecated. Use getLetter(String) instead.
Letter	getLetterWithoutData(String letterID) Deprecated.
List<DataModule>	getUsedDataModules(Letter letter, boolean fetchIndirectReferences) Deprecated.
List<DataModule>	getUsedDataModules(String letterID, boolean fetchIndirectReferences) Deprecated.
Map<ContainerLayoutAssignment,FragmentLayout>	getUsedFragmentLayouts(Letter letter, boolean fetchIndirectReferences) Deprecated.
Boolean	letterExists(String letterName) Deprecated.
Letter	publishLetter(String letterID) Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.
Letter	readLetter(String letterID) Deprecated.
Letter	readLetter(String letterID, boolean includedContent) Deprecated.
Letter	retrieveVersion(String letterId, Date publishDate) Deprecated.
Letter	revertToLastPublished(String letterId) Deprecated. Use AssetService.revertToLastPublished(String) instead.
boolean	updateDependencies(String oldLetterID, String newLetterID) Deprecated.
Letter	updateFMFormInLetter(String letterId, String fmFormPath) Deprecated.
Letter	updateLetter(Letter letter) Deprecated.

Method Detail

letterExists

@Deprecated
Boolean letterExists(String letterName)
                          throws ICCException

Deprecated.

Check if a Letter exists by the given name.

Parameters:

letterName - Name of the Letter.

Returns:

true if exists, false otherwise.

Throws:

ICCException

createLetterAndForm

@Deprecated
Letter createLetterAndForm(Letter letter)
                                throws ICCException

Deprecated.

Creates a new Letter object & Form object using FM Layout.

Parameters:

letter - The Letter to be created.

Returns:

created Letter object

Throws:

ICCException

createLetter

@Deprecated
Letter createLetter(Letter letter)
                         throws ICCException

Deprecated.

Create a new Letter from the input letter object.

Parameters:

letter - The Letter to be created.

Returns:

created Letter object

Throws:

ICCException

updateFMFormInLetter

@Deprecated
Letter updateFMFormInLetter(String letterId,
                                        String fmFormPath)
                                 throws ICCException

Deprecated.

Update the given Letter based on FM formPath.

Parameters:

letterId - id of the Letter object to be updated.

Returns:

updated Letter object.

Throws:

ICCException

updateLetter

@Deprecated
Letter updateLetter(Letter letter)
                         throws ICCException

Deprecated.

Update the given Letter.

Parameters:

letter - Letter object to be updated.

Returns:

updated Letter object.

Throws:

ICCException

activateLetter

@Deprecated
Letter activateLetter(String letterID,
                                  boolean updateDependencies)
                           throws ICCException

Deprecated. Use PublishService.publishAssets(List) instead

Activate the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter.

updateDependencies - Whether to set this new activated version in the dependencies.

Returns:

activated Letter object

Throws:

ICCException

publishLetter

@Deprecated
Letter publishLetter(String letterID)
                          throws ICCException

Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.

Publish the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter.

Returns:

activated Letter object

Throws:

ICCException

Since:

10.0.0.0

createTestLetter

@Deprecated
Letter createTestLetter(String letterID)
                             throws ICCException

Deprecated.

Create Test/Inactive version of Letter object.

Parameters:

letterID - ID of the Letter whose Inactive version is to be created.

Returns:

created Test/Inactive version Letter object.

Throws:

ICCException

copyLetter

@Deprecated
Letter copyLetter(String oldletterID,
                              Letter newletter)
                       throws ICCException

Deprecated.

Create a copy of the Letter identified by the oldletterID.

If the incoming Letter newletter does not have content in it, the content of the original Letter is set in it.

Parameters:

oldletterID - ID of the original Letter. Used to fetch the original content, if need be.

newletter - copy of the original Letter (may have properties altered by the user)

Returns:

Created copy of the Letter.

Throws:

ICCException

getAllLetters

@Deprecated
List<Letter> getAllLetters(Query query)
                                throws ICCException

Deprecated.

List all Letters 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

getAllLetters

@Deprecated
List<Letter> getAllLetters(Query query,
                                       String cutPoints)
                                throws ICCException

Deprecated.

List all Letters 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).

cutPoints - to fetch for each letter.

Returns:

List of Letter objects

Throws:

ICCException

See Also:

Statement, Query

getLetter

@Deprecated
Letter getLetter(String letterID,
                             boolean includedContent)
                      throws ICCException

Deprecated.

Fetch the Letter identified by the given letterID. This action is not audited for action type Read.

Parameters:

letterID - ID of the Letter to be fetched.

includedContent -

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

getLetter

@Deprecated
Letter getLetter(String letterID)
                      throws ICCException

Deprecated.

Fetch the Letter identified by the given letterID. This action is not audited for action type Read.

Parameters:

letterID - ID of the Letter to be fetched.

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

readLetter

@Deprecated
Letter readLetter(String letterID)
                       throws ICCException

Deprecated.

Fetch the Letter identified by the given letterID. This action is audited for action type Read.

Parameters:

letterID - ID of the Letter to be fetched.

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

readLetter

@Deprecated
Letter readLetter(String letterID,
                              boolean includedContent)
                       throws ICCException

Deprecated.

Fetch the Letter identified by the given letterID. This action is audited for action type Read.

Parameters:

letterID - ID of the Letter to be fetched.

includedContent - if includedContent is false then it will exclude all binary in complete hierarchy

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

getLetterWithoutData

@Deprecated
Letter getLetterWithoutData(String letterID)
                                 throws ICCException

Deprecated.

Fetch the Letter identified by the given letterID, removing the test data bytes and associated layout bytes in it.

Parameters:

letterID - ID of the Letter to be fetched.

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

getLetterWithLatestAssets

@Deprecated
Letter getLetterWithLatestAssets(String letterID)
                                      throws ICCException

Deprecated. Use getLetter(String) instead.

Fetch the Letter identified by the given letterID, with the latest versions of assets used in the letter. The actual versions of assets used in the Letter would be replaced by the latest available assets.
Note: If an Inactive version of an asset exists, then that is considered as the *latest* version of that asset.

Parameters:

letterID - ID of the Letter to be fetched.

Returns:

the Letter identified by the given letterID, built with the latest versions of used assets.

Throws:

ICCException

getUsedDataModules

@Deprecated
List<DataModule> getUsedDataModules(String letterID,
                                                boolean fetchIndirectReferences)
                                         throws ICCException

Deprecated.

Retrieve the list of all DataModules that is used by the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter, for which the used modules are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the modules that are directly or indirectly used by this Letter.
For example, if a Text T1 is used in a List L1, and List L1 is used in Letter L1, the List would contain (T1 and L1), for the Letter L1. If false, the List would contain only L1.

Returns:

List of all DataModules that is used by the Letter. Empty list returned, if the Letter does not use any other module.

Throws:

ICCException

getUsedDataModules

@Deprecated
List<DataModule> getUsedDataModules(Letter letter,
                                                boolean fetchIndirectReferences)
                                         throws ICCException

Deprecated.

Retrieve the list of all DataModules that is used by the Letter identified by the given letterID.

Parameters:

letter - Letter, for which the used modules are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the modules that are directly or indirectly used by this Letter.
For example, if a Text T1 is used in a List L1, and List L1 is used in Letter L1, the List would contain (T1 and L1), for the Letter L1. If false, the List would contain only L1.

Returns:

List of all DataModules that is used by the Letter. Empty list returned, if the Letter does not use any other module.

Throws:

ICCException

Since:

10.0.0.0

getUsedFragmentLayouts

@Deprecated
Map<ContainerLayoutAssignment,FragmentLayout> getUsedFragmentLayouts(Letter letter,
                                                                                 boolean fetchIndirectReferences)
                                                                          throws ICCException

Deprecated.

Retrieve the list of all the child ContainerLayoutAssignments of the Letter identified by the given letterID.

Parameters:

letter - Letter, for which the child container layout assignments are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the container layout assignments that are directly or indirectly used by this Letter.

Returns:

Map of all child ContainerLayoutAssignments and corresponding FragmentLayouts used in the Letter. Empty map returned, if the Letter does not use a FragmentLayout.

Throws:

ICCException

Since:

10.0.0.0

updateDependencies

@Deprecated
boolean updateDependencies(String oldLetterID,
                                       String newLetterID)
                                throws ICCException

Deprecated.

Update the references of the old Letter in any dependent assets with the new Letter.

Parameters:

oldLetterID - The old Letter ID.

newLetterID - The new Letter ID.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

getLetterDataElements

@Deprecated
Map<String,List> getLetterDataElements(String letterID)
                                            throws ICCException

Deprecated.

Gets information about data elements (element for which values can be updated for letter rendering).

Parameters:

letterID - the letter ID

Returns:

This API returns a map having three string keys "DDE" , "PH" and "Field" .

"DDE" is mapped with a list of DataDictionaryElements ( List ) for this letter. This consists of DDEs used in this letter as variable and also all the required DDEs.

"PH" is mapped with a list of Variables ( List ) which is used in this letter. Only variable of type place-holder which are used in variable assignment of this letter will be added into this list.

"Field" is mapped with a list of Fields object (List ) used in this letter. All fields used in field assignment of this Letter will be added in to this list.

Throws:

ICCException

revertToLastPublished

@Deprecated
Letter revertToLastPublished(String letterId)
                                  throws ICCException

Deprecated. Use AssetService.revertToLastPublished(String) instead.

Reverts the letter to the last published version. If letter is not published, it is removed from repository.

Parameters:

letterId - The Letter ID.

Returns:

Reverted letter.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

@Deprecated
Letter retrieveVersion(String letterId,
                                   Date publishDate)

Deprecated.

Returns the version of letter that was published on or before the specified date.

Parameters:

letterId - The Letter ID.

publishDate - specifies the date for fetching published letter.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0