|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LetterService
Service interface for Letter
specific operations.
Method Summary | |
---|---|
Letter |
activateLetter(java.lang.String letterID,
boolean updateDependencies)
Deprecated. |
Letter |
copyLetter(java.lang.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(java.lang.String letterID)
Deprecated. |
Letter |
deactivateLetter(java.lang.String letterId)
|
void |
deleteLetter(java.lang.String letterID)
Deprecated. |
java.util.List |
getAllLetters(Query query)
List all Letter s filtered by the given Query . |
java.util.List |
getDependentPortfolios(java.lang.String letterID)
Retrieve the list of Portfolio s dependent on the Letter identified by the given
letterID . |
Letter |
getLetter(java.lang.String letterID)
Fetch the Letter identified by the given letterID . |
java.util.Map |
getLetterDataElements(java.lang.String letterID)
Gets information about data elements (element for which values can be updated for letter rendering). |
Letter |
getLetterWithLatestAssets(java.lang.String letterID)
Deprecated. Use LetterService.getLetter(String) instead. |
Letter |
getLetterWithoutData(java.lang.String letterID)
Fetch the Letter identified by the given letterID , removing the test data bytes and associated layout bytes in it. |
java.util.List |
getUsedDataModules(Letter letter,
boolean fetchIndirectReferences)
Retrieve the list of all DataModule s that is used by the Letter identified by the given
letterID . |
java.util.List |
getUsedDataModules(java.lang.String letterID,
boolean fetchIndirectReferences)
Retrieve the list of all DataModule s that is used by the Letter identified by the given
letterID . |
java.util.Map |
getUsedFragmentLayouts(Letter letter,
boolean fetchIndirectReferences)
Retrieve the list of all the child ContainerLayoutAssignment s of the Letter identified by the given
letterID . |
boolean |
isReferenced(java.lang.String letterID)
Check if this Letter is being referenced by any other asset (Portfolio). |
java.lang.Boolean |
letterExists(java.lang.String letterName)
Check if a Letter exists by the given name. |
Letter |
markReadyToPublish(java.lang.String letterID)
Mark as ready to publish the Letter identified by the given letterID . |
Letter |
publishLetter(java.lang.String letterID)
Publish the Letter identified by the given letterID . |
Letter |
readLetter(java.lang.String letterID)
Fetch the Letter identified by the given letterID . |
Letter |
retrieveVersion(java.lang.String letterId,
java.util.Date publishDate)
Returns the version of letter that was published on or before the specified date. |
Letter |
revertToLastPublished(java.lang.String letterId)
Reverts the letter to the last published version. |
boolean |
updateDependencies(java.lang.String oldLetterID,
java.lang.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 |
---|
java.lang.Boolean letterExists(java.lang.String letterName) throws ICCException
Letter
exists by the given name.
letterName
- Name of the Letter
.
ICCException
void deleteLetter(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
.
letterID
- ID of the Letter
.
ICCException
Letter createLetter(Letter letter) throws ICCException
Letter
object.
letter
- The Letter
to be created.
Letter
object
ICCException
Letter updateLetter(Letter letter) throws ICCException
Letter
.
letter
- Letter
object to be updated.
Letter
object.
ICCException
Letter markReadyToPublish(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
.
letterID
- ID of the Letter
.
Letter
object marked for publishing
ICCException
Letter activateLetter(java.lang.String letterID, boolean updateDependencies) throws ICCException
Letter
identified by the given letterID
.
letterID
- ID of the Letter
.updateDependencies
- Whether to set this new activated version in the dependencies.
Letter
object
ICCException
Letter publishLetter(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
.
letterID
- ID of the Letter
.
Letter
object
ICCException
Letter createTestLetter(java.lang.String letterID) throws ICCException
Letter
object.
letterID
- ID of the Letter
whose Inactive version is to be created.
Letter
object.
ICCException
Letter copyLetter(java.lang.String oldletterID, Letter newletter) throws ICCException
Letter
identified by the oldletterID
.
newletter
does not have content in it, the content of the original Letter
is set in it.
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)
Letter
.
ICCException
java.util.List getAllLetters(Query query) throws ICCException
Letter
s filtered by the given Query
.
query
- Query to select Letter (supports only first level
attributes/properties of an object).Letter
objects
ICCException
Statement
,
Query
Letter getLetter(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
.
This action is not audited for action type Read.
letterID
- ID of the Letter
to be fetched.
Letter
identified by the given letterID
.
ICCException
Letter readLetter(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
.
This action is audited for action type Read.
letterID
- ID of the Letter
to be fetched.
Letter
identified by the given letterID
.
ICCException
Letter getLetterWithoutData(java.lang.String letterID) throws ICCException
Letter
identified by the given letterID
, removing the test data bytes and associated layout bytes in it.
letterID
- ID of the Letter
to be fetched.
Letter
identified by the given letterID
.
ICCException
Letter getLetterWithLatestAssets(java.lang.String letterID) throws ICCException
LetterService.getLetter(String)
instead.
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.
letterID
- ID of the Letter
to be fetched.
Letter
identified by the given letterID
, built with the latest versions of
used assets.
ICCException
java.util.List getDependentPortfolios(java.lang.String letterID) throws ICCException
Portfolio
s dependent on the Letter
identified by the given
letterID
.
letterID
- ID of the Letter
whose dependencies are to be fetched.
Portfolio
s which depend on the given Letter
.
ICCException
java.util.List getUsedDataModules(java.lang.String letterID, boolean fetchIndirectReferences) throws ICCException
DataModule
s that is used by the Letter
identified by the given
letterID
.
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.
DataModule
s that is used by the Letter
. Empty list returned, if the
Letter does not use any other module.
ICCException
java.util.List getUsedDataModules(Letter letter, boolean fetchIndirectReferences) throws ICCException
DataModule
s that is used by the Letter
identified by the given
letterID
.
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.
DataModule
s that is used by the Letter
. Empty list returned, if the
Letter does not use any other module.
ICCException
java.util.Map getUsedFragmentLayouts(Letter letter, boolean fetchIndirectReferences) throws ICCException
ContainerLayoutAssignment
s of the Letter
identified by the given
letterID
.
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.
ContainerLayoutAssignment
s and corresponding FragmentLayout
s used in the Letter
. Empty map returned, if the
Letter does not use a FragmentLayout
.
ICCException
boolean isReferenced(java.lang.String letterID) throws ICCException
letterID
- ID of the Letter
whose dependencies are to be fetched.
ICCException
boolean updateDependencies(java.lang.String oldLetterID, java.lang.String newLetterID) throws ICCException
oldLetterID
- The old Letter ID.newLetterID
- The new Letter ID.
ICCException
java.util.Map getLetterDataElements(java.lang.String letterID) throws ICCException
letterID
- the letter ID
ICCException
Letter revertToLastPublished(java.lang.String letterId) throws ICCException
letterID
- The Letter ID.
ICCException
Letter retrieveVersion(java.lang.String letterId, java.util.Date publishDate)
letterId
- The Letter ID.publishDate
- specifies the date for fetching published letter.
ICCException
Letter deactivateLetter(java.lang.String letterId)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |