public interface Configurator
Modifier and Type | Method and Description |
---|---|
java.util.List<ConfiguratorItem> |
getAllItems()
Gets all the Configuration items from the configuration XML.
|
java.lang.String |
getItemAttribute(java.lang.String path,
java.lang.String attribute)
Get attribute value of given path.
|
java.util.Map<java.lang.String,java.util.List<ConfiguratorItem>> |
getItems(java.util.List<java.lang.String> paths)
Get the
List of ConfiguratorItem s for the given list of paths. |
java.util.List<ConfiguratorItem> |
getItems(java.lang.String path)
Get the
List of ConfiguratorItem s for the given path. |
java.lang.String |
getItemValue(java.lang.String path)
Get the item value for a given path.
|
boolean |
isReadOnly(java.lang.String path)
Checks whether a particular element at the given path is read only or not.
|
void |
removeItem(ConfiguratorItem configItem)
Marking the given configurator item from the corresponding configuration layer as deleted.
|
void |
removeItems(java.lang.String path)
Marking all the ConfiguratorItems that exist in the given XPath as deleted.
|
void |
save()
Saves the modified configuration files.
|
void |
setItems(java.util.List<ConfiguratorItem> configItems)
Sets the given Configuration Items.
|
void |
sync()
Normally, the modification date of the DB file is checked for every property fetch.
|
java.util.List<ConfiguratorItem> getItems(java.lang.String path) throws CLLException
List
of ConfiguratorItem
s for the given path.path
- The path through the configuration XML fileList
of ConfiguratorItem
objects contained in the pathCLLException
- If an error occurs while trying to get the configurator itemsjava.util.Map<java.lang.String,java.util.List<ConfiguratorItem>> getItems(java.util.List<java.lang.String> paths) throws CLLException
List
of ConfiguratorItem
s for the given list of paths.paths
- The list of paths through the configuration XML fileMap
of List
of ConfiguratorItem
objects contained in the path for every path specified as a keyCLLException
- If an error occurs while trying to get the configurator itemsjava.lang.String getItemValue(java.lang.String path) throws CLLException
path
- The path through the configuration XML fileCLLException
- If an error occurs while trying to get the configurator itemjava.lang.String getItemAttribute(java.lang.String path, java.lang.String attribute) throws CLLException
path
- The path through the configuration XML fileattribute
- The attribute name at the given path elementCLLException
- If an error occurs while trying to get the configurator itemboolean isReadOnly(java.lang.String path) throws CLLException
path
- The path through the configuration XML fileCLLException
- If an error occurs while trying to get the configurator itemvoid save() throws CLLException
CLLException
- If an error occurs while trying to save the modifications to the configurationvoid setItems(java.util.List<ConfiguratorItem> configItems) throws CLLException
configItems
- The List
of ConfiguratorItem
objects to setCLLException
- If a CLL related error occursjava.util.List<ConfiguratorItem> getAllItems() throws CLLException
List
of all ConfiguratorItem
objects in the configuration fileCLLException
- If an error occurs while trying to get all the configurator item objectsvoid removeItem(ConfiguratorItem configItem) throws CLLException
configItem
- Element in the configuration file that should be marked as "deleted".CLLException
- In case of a failure to remove the configurator item from the corresponding configuration file.void removeItems(java.lang.String path) throws CLLException
path
- XPath used to identify the configuration elements from the configuration file.CLLException
- In case of a failure to remove the configurator items from the corresponding configuration file.void sync() throws CLLException
CLLException
- In case of a failure to perform the sync.