com.adobe.icc.services.api

Interface DataModuleService

Deprecated.

@Deprecated
public interface DataModuleService

Service interface for DataModule specific operations.

Method Summary

Modifier and Type	Method and Description
DataModule	activateDataModule(String dataModuleID, boolean updateDependencies) Deprecated. Use PublishService.publishAssets(List) instead
DataModule	copyDataModule(String oldDMID, DataModule newDM) Deprecated.
DataModule	createDataModule(DataModule dm) Deprecated.
DataModule	createTestDataModule(String dataModuleID) Deprecated.
boolean	dataModuleExists(String dataModuleName) Deprecated.
List<DataModule>	getAllDataModules(Query query) Deprecated.
List<DataModule>	getAllDataModules(Query query, String cutPoints) Deprecated.
DataModule	getDataModule(String dmID) Deprecated.
DataModule	getDataModule(String dmID, boolean includeContent) Deprecated.
List<DataModule>	getDependentDataModules(String moduleID) Deprecated.
List<DataModule>	getDependentDataModules(String moduleID, boolean fetchIndirectReferences) Deprecated. Use getDependentDataModules(String, boolean, String, boolean) instead.
List<DataModule>	getDependentDataModules(String moduleID, boolean fetchIndirectReferences, String cutPoints, boolean includeContent) Deprecated.
List<Letter>	getDependentLetters(String moduleID) Deprecated.
List<Letter>	getDependentLetters(String moduleID, boolean fetchIndirectReferences) Deprecated. Use getDependentLetters(String, boolean, String, boolean) instead.
List<Letter>	getDependentLetters(String moduleID, boolean fetchIndirectReferences, String cutPoints, boolean includeContent) Deprecated.
List<DataModule>	getUsedDataModules(String moduleID, boolean fetchIndirectReferences) Deprecated.
boolean	isReferenced(String moduleID) Deprecated.
DataModule	publishDataModule(String dataModuleID) Deprecated. Since 6.2. Use PublishService.publishAssets(List) instead.
DataModule	readDataModule(String dmID) Deprecated.
DataModule	readDataModule(String dmID, boolean includeContent) Deprecated.
DataModule	retrieveVersion(String dataModuleId, Date publishDate) Deprecated.
DataModule	revertToLastPublished(String dataModuleId) Deprecated. Use AssetService.revertToLastPublished(String) instead.
DataModule	updateDataModule(DataModule dm) Deprecated.
boolean	updateDependencies(DataModule oldModule, DataModule newModule) Deprecated.
Set<Letter>	updateDependencies(DataModule oldModule, DataModule newModule, List<Letter> letters) Deprecated.
boolean	updateEffectiveDependencies(DataModule oldModule, DataModule newModule, List<String> lettersToBeIgnored) Deprecated.

Method Detail

dataModuleExists

@Deprecated
boolean dataModuleExists(String dataModuleName)
                              throws ICCException

Deprecated.

Check if a DataModule exists by the given name.

Parameters:

dataModuleName - Name of the DataModule.

Returns:

true if exists, false otherwise.

Throws:

ICCException

createDataModule

@Deprecated
DataModule createDataModule(DataModule dm)
                                 throws ICCException

Deprecated.

Create a new DataModule object.

Parameters:

dm - The DataModule to be created.

Returns:

created DataModule object

Throws:

ICCException

createTestDataModule

@Deprecated
DataModule createTestDataModule(String dataModuleID)
                                     throws ICCException

Deprecated.

Create Test/Inactive version of DataModule object.

Parameters:

dataModuleID - ID of the DataModule whose Inactive version is to be created.

Returns:

created Test/Inactive version DataModule object.

Throws:

ICCException

activateDataModule

@Deprecated
DataModule activateDataModule(String dataModuleID,
                                          boolean updateDependencies)
                                   throws ICCException

Deprecated. Use PublishService.publishAssets(List) instead

Activate the DataModule identified by the given dataModuleID.

Parameters:

dataModuleID - ID of the DataModule.

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

Returns:

activated DataModule object

Throws:

ICCException

publishDataModule

@Deprecated
DataModule publishDataModule(String dataModuleID)
                                  throws ICCException

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

Publish the DataModule identified by the given dataModuleID.

Parameters:

dataModuleID - ID of the DataModule.

Returns:

published DataModule object

Throws:

ICCException

Since:

10.0.0.0

getAllDataModules

@Deprecated
List<DataModule> getAllDataModules(Query query,
                                               String cutPoints)
                                        throws ICCException

Deprecated.

List all DataModules filtered by the given Query.

Parameters:

query - Query to select data modules (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 (DataModule object, in this case).

cutPoints -

Returns:

List of DataModule objects.

Throws:

ICCException

See Also:

Statement, Query

getAllDataModules

@Deprecated
List<DataModule> getAllDataModules(Query query)
                                        throws ICCException

Deprecated.

List all DataModules filtered by the given Query.

Parameters:

query - Query to select data modules (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 (DataModule object, in this case).

Returns:

List of DataModule objects.

Throws:

ICCException

See Also:

Statement, Query

updateDataModule

@Deprecated
DataModule updateDataModule(DataModule dm)
                                 throws ICCException

Deprecated.

Update the given DataModule.

Parameters:

dm - DataModule object to be updated.

Returns:

updated DataModule object.

Throws:

ICCException

getDataModule

@Deprecated
DataModule getDataModule(String dmID)
                              throws ICCException

Deprecated.

Fetch the DataModule identified by the given dmID. This action is not audited for action type Read.

Parameters:

dmID - ID of the DataModule to be fetched.

Returns:

the DataModule identified by the given dmID.

Throws:

ICCException

getDataModule

@Deprecated
DataModule getDataModule(String dmID,
                                     boolean includeContent)
                              throws ICCException

Deprecated.

Fetch the DataModule identified by the given dmID. This action is not audited for action type Read.

Parameters:

dmID - ID of the DataModule to be fetched.

includeContent -

Returns:

the DataModule identified by the given dmID.

Throws:

ICCException

readDataModule

@Deprecated
DataModule readDataModule(String dmID)
                               throws ICCException

Deprecated.

Fetch the DataModule identified by the given dmID. This action is audited for action type Read.

Parameters:

dmID - ID of the DataModule to be fetched.

Returns:

the DataModule identified by the given dmID.

Throws:

ICCException

readDataModule

@Deprecated
DataModule readDataModule(String dmID,
                                      boolean includeContent)
                               throws ICCException

Deprecated.

Fetch the DataModule identified by the given dmID. This action is audited for action type Read.

Parameters:

dmID - ID of the DataModule to be fetched.

includeContent -

Returns:

the DataModule identified by the given dmID.

Throws:

ICCException

copyDataModule

@Deprecated
DataModule copyDataModule(String oldDMID,
                                      DataModule newDM)
                               throws ICCException

Deprecated.

Create a copy of the DataModule identified by the oldDMID.

If the incoming Data module newDM does not have content in it, the content of the original module is set in it.

Parameters:

oldDMID - ID of the original DataModule. Used to fetch the original content, if need be.

newDM - copy of the original Data Module (may have properties altered by the user)

Returns:

Created copy of the DataModule.

Throws:

ICCException

getDependentLetters

@Deprecated
List<Letter> getDependentLetters(String moduleID)
                                      throws ICCException

Deprecated.

Retrieve the list of Letters (directly) dependent on the DataModule identified by the given moduleID.
It is recommended to use the alternate API getDependentLetters(String, boolean)

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

Returns:

List of Letters which depend on the given DataModule.

Throws:

ICCException

See Also:

getDependentLetters(String, boolean)

getDependentLetters

@Deprecated
List<Letter> getDependentLetters(String moduleID,
                                             boolean fetchIndirectReferences)
                                      throws ICCException

Deprecated. Use getDependentLetters(String, boolean, String, boolean) instead.

Retrieve the list of Letters dependent on the DataModule identified by the given moduleID.

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the Letters that directly or indirectly use this module.
For example, if a Letter L1 uses a Text T1; and another Letter L2 uses List L1, which in turn uses Text T1, then the List returned would contain (L1 and L2), for the Text T1. If False, the List returned would contain only L1. (L1 and C1). If false, the List would contain only L1.

Returns:

List of Letters which depend on the given DataModule.

Throws:

ICCException

getDependentLetters

@Deprecated
List<Letter> getDependentLetters(String moduleID,
                                             boolean fetchIndirectReferences,
                                             String cutPoints,
                                             boolean includeContent)
                                      throws ICCException

Deprecated.

Retrieve the list of Letters dependent on the DataModule identified by the given moduleID.

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the Letters that directly or indirectly use this module.

cutPoints - Cut Points to be fetched for letters. If null association cut points for dependent letters will be used.
For example, if a Letter L1 uses a Text T1; and another Letter L2 uses List L1, which in turn uses Text T1, then the List returned would contain (L1 and L2), for the Text T1. If False, the List returned would contain only L1. (L1 and C1). If false, the List would contain only L1.

includeContent - Whether to include binaries or not?

Returns:

List of Letters which depend on the given DataModule.

Throws:

ICCException

getDependentDataModules

@Deprecated
List<DataModule> getDependentDataModules(String moduleID)
                                              throws ICCException

Deprecated.

Retrieve the list of other DataModules (directly) dependent on the DataModule identified by the given moduleID.
It is recommended to use the alternate API getDependentDataModules(String, boolean)

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

Returns:

List of other DataModules dependent on the DataModule.

Throws:

ICCException

See Also:

getDependentDataModules(String, boolean)

getDependentDataModules

@Deprecated
List<DataModule> getDependentDataModules(String moduleID,
                                                     boolean fetchIndirectReferences)
                                              throws ICCException

Deprecated. Use getDependentDataModules(String, boolean, String, boolean) instead.

Retrieve the list of other DataModules dependent on the DataModule identified by the given moduleID.

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

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

Returns:

List of other DataModules dependent on the DataModule.

Throws:

ICCException

getDependentDataModules

@Deprecated
List<DataModule> getDependentDataModules(String moduleID,
                                                     boolean fetchIndirectReferences,
                                                     String cutPoints,
                                                     boolean includeContent)
                                              throws ICCException

Deprecated.

Retrieve the list of other DataModules dependent on the DataModule identified by the given moduleID.

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

fetchIndirectReferences - True, if you wish to fetch the modules that directly or indirectly use this module.

includeContent - Whether to include binaries or not?

cutPoints - Cut Points to fetch for dependent data Modules. If null association cut points for dependent data modules will be used.
For example, if a Text T1 is used in a List L1, and List L1 is used in Condition C1, the List would contain (L1 and C1), for the Text T1. If false, the List would contain only L1.

Returns:

List of other DataModules dependent on the DataModule.

Throws:

ICCException

getUsedDataModules

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

Deprecated.

Retrieve the list of other DataModules that is used by the DataModule identified by the given moduleID.

Parameters:

moduleID - ID of the DataModule, 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 module.
For example, if a Text T1 is used in a List L1, and List L1 is used in Condition C1, the List would contain (T1 and L1), for the Condition C1. If false, the List would contain only L1.

Returns:

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

Throws:

ICCException

isReferenced

@Deprecated
boolean isReferenced(String moduleID)
                          throws ICCException

Deprecated.

Check if this data module is being referenced by any other asset (Letter/DataModule).

Parameters:

moduleID - ID of the DataModule whose dependencies are to be fetched.

Returns:

True, if the Data Module is being referenced, False otherwise.

Throws:

ICCException

updateDependencies

@Deprecated
boolean updateDependencies(DataModule oldModule,
                                       DataModule newModule)
                                throws ICCException

Deprecated.

Update the references of the old data module oldModule, in any dependent assets, with the new data module newModule.

Parameters:

oldModule - The old data module object.

newModule - The new data module object, which should be set as the new reference.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

updateEffectiveDependencies

@Deprecated
boolean updateEffectiveDependencies(DataModule oldModule,
                                                DataModule newModule,
                                                List<String> lettersToBeIgnored)
                                         throws ICCException

Deprecated.

Update the references of the old data module oldModule, in any dependent assets, with the new data module newModule. The list of Letters names which are passed in the third parameter are ignored.

Parameters:

oldModule - The old data module object.

newModule - The new data module object, which should be set as the new reference.

lettersToBeIgnored - List of Letter Names which are to be ignored while updating the dependent Letters.

Returns:

True if the operation succeeds, False otherwise.

Throws:

ICCException

updateDependencies

@Deprecated
Set<Letter> updateDependencies(DataModule oldModule,
                                           DataModule newModule,
                                           List<Letter> letters)
                                    throws ICCException

Deprecated.

Update the references of the old data module oldModule, in given dependent assets (passed as third parameter), with the new data module newModule.

Parameters:

oldModule - The old data module object.

newModule - The new data module object, which should be set as the new reference.

letters - List of letters required to be updated.

Returns:

set containing updated letters.

Throws:

ICCException

Since:

10.0.0.0

revertToLastPublished

@Deprecated
DataModule revertToLastPublished(String dataModuleId)
                                      throws ICCException

Deprecated. Use AssetService.revertToLastPublished(String) instead.

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

Parameters:

dataModuleId - The data module ID.

Returns:

Reverted data module.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

@Deprecated
DataModule retrieveVersion(String dataModuleId,
                                       Date publishDate)

Deprecated.

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

Parameters:

dataModuleId - The Data module ID.

publishDate - specifies the date for fetching published data module.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0