com.adobe.dct.service

Interface DataDictionaryRegistryService

Deprecated.

@Deprecated
public interface DataDictionaryRegistryService

This defines all the persistence layer API's for objects present in Data Dictionary(DCT).

Method Summary

Modifier and Type	Method and Description
DataDictionary	copy(String srcDDId, String destDDName, String destDDTitle) Deprecated.
DataDictionary	copy(String srcDDId, String destFolderId, String destDDName, String destDDTitle) Deprecated.
Map<String,CopiedAssetInfo>	copyDataDictonaries(Map<String,CopiedAssetInfo> copiedDDInfoMap, String destinationFolderPath) Deprecated.
String	createDataDictionary(DataDictionary dictionary) Deprecated.
DataDictionary	deactivateDataDictionary(String id) Deprecated.
void	deleteDataDictionaries(String[] ids) Deprecated.
void	deleteDataDictionary(String id) Deprecated.
List<DataDictionary>	getAllDataDictionaries() Deprecated.
List<DataDictionaryReference>	getAllDataDictionaryReferences() Deprecated. since 6.3, use getFirstLevelDataDictionaries(DataDictionarySearchFilter) instead.
List<DataDictionary>	getDataDictionaries(DataDictionarySearchFilter searchFilter) Deprecated.
DataDictionary	getDataDictionary(String id) Deprecated.
List<DataDictionaryReference>	getDataDictionaryReferences(DataDictionarySearchFilter searchFilter) Deprecated. since 6.3, use getFirstLevelDataDictionaries(DataDictionarySearchFilter) instead.
List<DataDictionary>	getFirstLevelDataDictionaries(DataDictionarySearchFilter searchFilter) Deprecated.
DataDictionary	getFirstLevelDataDictionary(String id) Deprecated.
List<DataDictionary>	getFirstLevelSystemDataDictionaries() Deprecated. since 6.3, System DataDictionaries are removed.
List<DataDictionary>	getSystemDataDictionaries(String locale) Deprecated. since 6.3, System DataDictionaries are removed.
DataDictionary	publishDataDictionary(String id) Deprecated.
DataDictionary	readDataDictionary(String id) Deprecated.
DataDictionary	retrieveVersion(String id, Date publishDate) Deprecated.
DataDictionary	revertToLastPublished(String id) Deprecated.
void	updateDataDictionary(DataDictionary dictionary) Deprecated.
void	updateDataDictionaryWithTestData(String id, byte[] data) Deprecated.

Method Detail

getFirstLevelDataDictionary

@Deprecated
DataDictionary getFirstLevelDataDictionary(String id)
                                                throws DCTException

Deprecated.

Obtain a data dictionary object corresponding to the data dictionary Id. This Data Dictionary object contains only first level properties.

Parameters:

id - data dictionary identifier

Returns:

data dictionary

Throws:

DCTException

getDataDictionary

@Deprecated
DataDictionary getDataDictionary(String id)
                                      throws DCTException

Deprecated.

Obtain a data dictionary object corresponding to the data dictionary Id This API is not audited for action type Read.

Parameters:

id - data dictionary identifier

Returns:

data dictionary

Throws:

DCTException

createDataDictionary

@Deprecated
String createDataDictionary(DataDictionary dictionary)
                                 throws DCTException

Deprecated.

This API creates a data dictionary in persistent store and returns the unique identifier of stored DD. Name field in data dictionary is mandatory. The name of data dictionary is unique within the folder and hence in case of name collisions this api will throw exception. If identifier property is set in the Data Dictionary, it gets ignored by the api.

Parameters:

dictionary - data dictionary object

Returns:

id of data dictionary

Throws:

DCTException

updateDataDictionaryWithTestData

@Deprecated
void updateDataDictionaryWithTestData(String id,
                                                  byte[] data)
                                           throws DCTException

Deprecated.

This API updates the testdata for an already existing data dictionary present in the system set with the same identifier.

Parameters:

id - Id of the datadictionary to be modified.

data - bytes of the test data to be added.

Throws:

DCTException

updateDataDictionary

@Deprecated
void updateDataDictionary(DataDictionary dictionary)
                               throws DCTException

Deprecated.

This API updates an already existing data dictionary present in the system set with the same identifier. Name and Id fields in data dictionary are mandatory. The name of data dictionary is unique within the folder and hence in case of name collisions this api will throw exception.

Parameters:

dictionary - data dictionary object

Throws:

DCTException

deleteDataDictionary

@Deprecated
void deleteDataDictionary(String id)
                               throws DCTException

Deprecated.

Delete data dictionary based on the identifier. This works in CASCADE-DELETE mode for the complete data dictionary tree.

Parameters:

id - identifier of data dictionary

Throws:

DCTException

deleteDataDictionaries

@Deprecated
void deleteDataDictionaries(String[] ids)
                                 throws DCTException

Deprecated.

Delete data dictionaries based on the identifier. This works in CASCADE-DELETE mode for the complete data dictionary tree.

Parameters:

ids - array of data dictionary

Throws:

DCTException

getAllDataDictionaries

@Deprecated
List<DataDictionary> getAllDataDictionaries()
                                                 throws DCTException

Deprecated.

Obtain all data dictionaries present in the system.

Returns:

list of data dictionaries

Throws:

DCTException

getDataDictionaries

@Deprecated
List<DataDictionary> getDataDictionaries(DataDictionarySearchFilter searchFilter)
                                              throws DCTException

Deprecated.

Obtain all data dictionaries based on search filter

Parameters:

searchFilter - search criteria for data dictionary search like name, type...

Returns:

list of data dictionaries matching the search criteria

Throws:

DCTException

getFirstLevelDataDictionaries

@Deprecated
List<DataDictionary> getFirstLevelDataDictionaries(DataDictionarySearchFilter searchFilter)
                                                        throws DCTException

Deprecated.

Obtain all data dictionaries based on search filter. Only first level properties of data dictionaries are fetched.

Parameters:

searchFilter - search criteria for data dictionary search like name, type...

Returns:

list of data dictionaries matching the search criteria.

Throws:

DCTException

getAllDataDictionaryReferences

@Deprecated
List<DataDictionaryReference> getAllDataDictionaryReferences()
                                                                  throws DCTException

Deprecated. since 6.3, use getFirstLevelDataDictionaries(DataDictionarySearchFilter) instead.

Obtain all data dictionary references present in the system

Returns:

list of data dictionary references

Throws:

DCTException

getDataDictionaryReferences

@Deprecated
List<DataDictionaryReference> getDataDictionaryReferences(DataDictionarySearchFilter searchFilter)
                                                               throws DCTException

Deprecated. since 6.3, use getFirstLevelDataDictionaries(DataDictionarySearchFilter) instead.

Obtain all data dictionary references based on search filter

Parameters:

searchFilter - search criteria for data dictionary search like name, type...

Returns:

list of data dictionary references matching the search criteria

Throws:

DCTException

getFirstLevelSystemDataDictionaries

@Deprecated
List<DataDictionary> getFirstLevelSystemDataDictionaries()
                                                              throws DCTException

Deprecated. since 6.3, System DataDictionaries are removed.

Obtain all SYSTEM data dictionaries with only first level information.

Returns:

list of SYSTEM data dictionaries

Throws:

DCTException

getSystemDataDictionaries

@Deprecated
List<DataDictionary> getSystemDataDictionaries(String locale)
                                                    throws DCTException

Deprecated. since 6.3, System DataDictionaries are removed.

Obtain all SYSTEM data dictionaries

Parameters:

locale - locale for which the system data dictionaries are fetched

Returns:

list of SYSTEM data dictionaries

Throws:

DCTException

publishDataDictionary

@Deprecated
DataDictionary publishDataDictionary(String id)
                                          throws DCTException

Deprecated.

Publish the data dictionary identified by the given id.

Parameters:

id - identifier of the data dictionary

Returns:

The published Data Dictionary object.

Throws:

DCTException

revertToLastPublished

@Deprecated
DataDictionary revertToLastPublished(String id)
                                          throws DCTException

Deprecated.

Revert to the last published version of the data dictionary identified by the given id.

Parameters:

id - identifier of the data dictionary

Returns:

The last published version of the Data Dictionary.

Throws:

DCTException

deactivateDataDictionary

@Deprecated
DataDictionary deactivateDataDictionary(String id)
                                             throws DCTException

Deprecated.

Unpublish the data dictionary identified by the given id.

Parameters:

id - identifier of the data dictionary

Returns:

The latest version of the Data Dictionary after unpublish.

Throws:

DCTException

readDataDictionary

@Deprecated
DataDictionary readDataDictionary(String id)
                                       throws DCTException

Deprecated.

Obtain a data dictionary object corresponding to the data dictionary Id. This API is audited for action type Read.

Parameters:

id - data dictionary identifier

Returns:

data dictionary

Throws:

DCTException

retrieveVersion

@Deprecated
DataDictionary retrieveVersion(String id,
                                           Date publishDate)
                                    throws DCTException

Deprecated.

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

Parameters:

id - The DataDictionary ID.

publishDate - specifies the date for fetching published dataDictionary.

Returns:

dataDictionary version which was published on or before the specified date.

Throws:

DCTException

copy

@Deprecated
DataDictionary copy(String srcDDId,
                                String destDDName,
                                String destDDTitle)
                         throws DCTException

Deprecated.

Creates a copy of DataDictionary represented by srcDDId with the given name destDDName and title destDDTitle.

Parameters:

srcDDId - Id (path) of the DataDictionary to be copied.

destDDName - Name to be assigned to created copy of source DataDictionary.

destDDTitle - Title to be assigned to created copy of source DataDictionary.

Returns:

copied DataDictionary.

Throws:

DCTException

copy

@Deprecated
DataDictionary copy(String srcDDId,
                                String destFolderId,
                                String destDDName,
                                String destDDTitle)
                         throws DCTException

Deprecated.

Creates a copy of DataDictionary represented by srcDDId with the given folder location destFolderId, name destDDName and title destDDTitle.

Parameters:

srcDDId - Id (path) of the DataDictionary to be copied.

destFolderId - Complete Id (path) of folder where asset should be copied.

destDDName - Name to be assigned to created copy of source DataDictionary.

destDDTitle - Title to be assigned to created copy of source DataDictionary.

Returns:

copied DataDictionary.

Throws:

DCTException

copyDataDictonaries

@Deprecated
Map<String,CopiedAssetInfo> copyDataDictonaries(Map<String,CopiedAssetInfo> copiedDDInfoMap,
                                                            String destinationFolderPath)
                                                     throws DCTException

Deprecated.

Creates a copy of all assets present in copiedDDInfoMap at destinationFolderPath and returns the assets which are not copied.

Parameters:

copiedDDInfoMap -

destinationFolderPath -

Returns:

a map of assets which are not copied

Throws:

DCTException