com.adobe.dct.service
Interface DataDictionaryRegistryService

public interface DataDictionaryRegistryService

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

Method Summary

java.lang.String	createDataDictionary(DataDictionary dictionary) This API creates a data dictionary in persistent store and returns the unique identifier of stored DD.
void	deleteDataDictionary(java.lang.String id) Delete data dictionary based on the identifier.
java.util.List	getAllDataDictionaries() Obtain all data dictionaries present in the system.
java.util.List	getAllDataDictionaryReferences() Obtain all data dictionary references present in the system
java.util.List	getDataDictionaries(DataDictionarySearchFilter searchFilter) Obtain all data dictionaries based on search filter
DataDictionary	getDataDictionary(java.lang.String id) Obtain a data dictionary object corresponding to the data dictionary Id This API is not audited for action type Read.
DataDictionary	getDataDictionary(java.lang.String id, boolean validateCache) This method is not intended for external use.
java.util.List	getDataDictionaryReferences(DataDictionarySearchFilter searchFilter) Obtain all data dictionary references based on search filter
DataDictionary	getFirstLevelDataDictionary(java.lang.String id) Obtain a data dictionary object corresponding to the data dictionary Id.
java.util.List	getFirstLevelSystemDataDictionaries() Obtain all SYSTEM data dictionaries with only first level information.
java.util.List	getSystemDataDictionaries(java.lang.String locale) Obtain all SYSTEM data dictionaries
DataDictionary	markReadyToPublish(java.lang.String id) Mark the given Data Dictionary read to Publish.
DataDictionary	publishDataDictionary(java.lang.String id) Publish the data dictionary identified by the given id.
DataDictionary	readDataDictionary(java.lang.String id) Obtain a data dictionary object corresponding to the data dictionary Id.
DataDictionary	revertToLastPublished(java.lang.String id) Revert to the last published version of the data dictionary identified by the given id.
void	updateDataDictionary(DataDictionary dictionary) This API updates an already existing data dictionary present in the system set with the same identifier.

Method Detail

getFirstLevelDataDictionary

DataDictionary getFirstLevelDataDictionary(java.lang.String id)
                                           throws DCTException

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

DataDictionary getDataDictionary(java.lang.String id)
                                 throws DCTException

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

getDataDictionary

DataDictionary getDataDictionary(java.lang.String id,
                                 boolean validateCache)
                                 throws DCTException

This method is not intended for external use. This method fetches a data dictionary object corresponding to the data dictionary Id and takes and additional parameter validateCache determines whether the cache needs to be validated or not.

Parameters:

id - data dictionary identifier

valdateCache - - if the DataDictionary is cached, then this parameter determines whether the cache needs to be validated or not.

Returns:

data dictionary

Throws:

DCTException

createDataDictionary

java.lang.String createDataDictionary(DataDictionary dictionary)
                                      throws DCTException

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 system 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

updateDataDictionary

void updateDataDictionary(DataDictionary dictionary)
                          throws DCTException

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 system and hence in case of name collisions this api will throw exception.

Parameters:

dictionary - data dictionary object

Throws:

DCTException

deleteDataDictionary

void deleteDataDictionary(java.lang.String id)
                          throws DCTException

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

getAllDataDictionaries

java.util.List getAllDataDictionaries()
                                      throws DCTException

Obtain all data dictionaries present in the system.

Returns:

list of data dictionaries

Throws:

DCTException

getDataDictionaries

java.util.List getDataDictionaries(DataDictionarySearchFilter searchFilter)
                                   throws DCTException

Obtain all data dictionaries based on search filter

Parameters:

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

Returns:

list of data dictionaries matching the search criteria

Throws:

DCTException

getAllDataDictionaryReferences

java.util.List getAllDataDictionaryReferences()
                                              throws DCTException

Obtain all data dictionary references present in the system

Returns:

list of data dictionary references

Throws:

DCTException

getDataDictionaryReferences

java.util.List getDataDictionaryReferences(DataDictionarySearchFilter searchFilter)
                                           throws DCTException

Obtain all data dictionary references based on search filter

Parameters:

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

Returns:

list of data dictionary references matching the search criteria

Throws:

DCTException

getFirstLevelSystemDataDictionaries

java.util.List getFirstLevelSystemDataDictionaries()
                                                   throws DCTException

Obtain all SYSTEM data dictionaries with only first level information.

Returns:

list of SYSTEM data dictionaries

Throws:

DCTException

getSystemDataDictionaries

java.util.List getSystemDataDictionaries(java.lang.String locale)
                                         throws DCTException

Obtain all SYSTEM data dictionaries

Parameters:

locale - locale for which the system data dictionaries are fetched

Returns:

list of SYSTEM data dictionaries

Throws:

DCTException

markReadyToPublish

DataDictionary markReadyToPublish(java.lang.String id)
                                  throws DCTException

Mark the given Data Dictionary read to Publish.

Parameters:

id - identifier of the data dictionary

Returns:

Data Dictionary object that was marked ready to publish.

Throws:

DCTException

publishDataDictionary

DataDictionary publishDataDictionary(java.lang.String id)
                                     throws DCTException

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

DataDictionary revertToLastPublished(java.lang.String id)
                                     throws DCTException

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

readDataDictionary

DataDictionary readDataDictionary(java.lang.String id)
                                  throws DCTException

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