com.adobe.icc.services.api
Interface LetterService

public interface LetterService

Service interface for Letter specific operations.

Method Summary

Letter	activateLetter(String letterID, boolean updateDependencies) Deprecated.
Letter	copyLetter(String oldletterID, Letter newletter) Create a copy of the Letter identified by the oldletterID.
Letter	createLetter(Letter letter) Create a new Letter object.
Letter	createTestLetter(String letterID) Deprecated.
void	deleteLetter(String letterID) Deprecated.
List	getAllLetters(Query query) List all Letters filtered by the given Query.
List	getDependentPortfolios(String letterID) Retrieve the list of Portfolios dependent on the Letter identified by the given letterID.
Letter	getLetter(String letterID) Fetch the Letter identified by the given letterID.
Map	getLetterDataElements(String letterID) Gets information about data elements (element for which values can be updated for letter rendering).
Letter	getLetterWithLatestAssets(String letterID) Deprecated. Use LetterService.getLetter(String) instead.
List	getUsedDataModules(Letter letter, boolean fetchIndirectReferences) Retrieve the list of all DataModules that is used by the Letter identified by the given letterID.
List	getUsedDataModules(String letterID, boolean fetchIndirectReferences) Retrieve the list of all DataModules that is used by the Letter identified by the given letterID.
Map	getUsedFragmentLayouts(Letter letter, boolean fetchIndirectReferences) Retrieve the list of all the child ContainerLayoutAssignments of the Letter identified by the given letterID.
boolean	isReferenced(String letterID) Check if this Letter is being referenced by any other asset (Portfolio).
Boolean	letterExists(String letterName) Check if a Letter exists by the given name.
Letter	markReadyToPublish(String letterID) Mark as ready to publish the Letter identified by the given letterID.
Letter	publishLetter(String letterID) Publish the Letter identified by the given letterID.
Letter	retrieveVersion(String letterId, Date publishDate) Returns the version of letter that was published on or before the specified date.
Letter	revertToLastPublished(String letterId) Reverts the letter to the last published version.
boolean	updateDependencies(String oldLetterID, String newLetterID) Update the references of the old Letter in any dependent assets with the new Letter.
Letter	updateLetter(Letter letter) Update the given Letter.

Method Detail

letterExists

Boolean letterExists(String letterName)
                     throws ICCException

Check if a Letter exists by the given name.

Parameters:

letterName - Name of the Letter.

Returns:

true if exists, false otherwise.

Throws:

ICCException

deleteLetter

void deleteLetter(String letterID)
                  throws ICCException

Deprecated.

Delete the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter.

Throws:

ICCException

createLetter

Letter createLetter(Letter letter)
                    throws ICCException

Create a new Letter object.

Parameters:

letter - The Letter to be created.

Returns:

created Letter object

Throws:

ICCException

updateLetter

Letter updateLetter(Letter letter)
                    throws ICCException

Update the given Letter.

Parameters:

letter - Letter object to be updated.

Returns:

updated Letter object.

Throws:

ICCException

markReadyToPublish

Letter markReadyToPublish(String letterID)
                          throws ICCException

Mark as ready to publish the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter.

Returns:

Letter object marked for publishing

Throws:

ICCException

Since:

10.0.0.0

activateLetter

Letter activateLetter(String letterID,
                      boolean updateDependencies)
                      throws ICCException

Deprecated.

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

Letter publishLetter(String letterID)
                     throws ICCException

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

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

Letter copyLetter(String oldletterID,
                  Letter newletter)
                  throws ICCException

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

List getAllLetters(Query query)
                   throws ICCException

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} and {@link Query}.

getLetter

Letter getLetter(String letterID)
                 throws ICCException

Fetch the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter to be fetched.

Returns:

the Letter identified by the given letterID.

Throws:

ICCException

getLetterWithLatestAssets

Letter getLetterWithLatestAssets(String letterID)
                                 throws ICCException

Deprecated. Use LetterService.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

getDependentPortfolios

List getDependentPortfolios(String letterID)
                            throws ICCException

Retrieve the list of Portfolios dependent on the Letter identified by the given letterID.

Parameters:

letterID - ID of the Letter whose dependencies are to be fetched.

Returns:

List of Portfolios which depend on the given Letter.

Throws:

ICCException

getUsedDataModules

List getUsedDataModules(String letterID,
                        boolean fetchIndirectReferences)
                        throws ICCException

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

List getUsedDataModules(Letter letter,
                        boolean fetchIndirectReferences)
                        throws ICCException

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

Map getUsedFragmentLayouts(Letter letter,
                           boolean fetchIndirectReferences)
                           throws ICCException

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

Parameters:

letterID - ID of the 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 (@link FragmentLayout)s used in the Letter. Empty map returned, if the Letter does not use a (@link FragmentLayout).

Throws:

ICCException

Since:

10.0.0.0

isReferenced

boolean isReferenced(String letterID)
                     throws ICCException

Check if this Letter is being referenced by any other asset (Portfolio).

Parameters:

letterID - ID of the Letter whose dependencies are to be fetched.

Returns:

True, if the Letter is being referenced, False otherwise.

Throws:

ICCException

updateDependencies

boolean updateDependencies(String oldLetterID,
                           String newLetterID)
                           throws ICCException

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

Map getLetterDataElements(String letterID)
                          throws ICCException

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

Letter revertToLastPublished(String letterId)
                             throws ICCException

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

Letter retrieveVersion(String letterId,
                       Date publishDate)

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