/// <summary>
/// Called when the system wants to upgrade the current configuration.
/// </summary>
/// <param name="config">The configuration information that can be used to upgrade the configuration.
/// It also contains the module and action configurations that have already been saved.</param>
/// <returns>
/// Returns the item configuration that must be saved; otherwise <c>null</c> if an error occured by upgrading the item configuration.
/// </returns>
public Development.SDK.Module.Data.Common.ItemConfig Upgrade(Development.SDK.Module.Data.Common.ConfigInformation config)
{
// Define item and module configuration object
Data.Processor.Config processorConfig = null;
Development.SDK.Module.Data.Common.ItemConfig itemConfig = null;
// Create new item configuration instance.
itemConfig = new Development.SDK.Module.Data.Common.ItemConfig();
if (config != null)
{
// Get configuration
processorConfig = new Data.Processor.Config();
processorConfig.Config1 = config.Parameters["config_1"];
processorConfig.Config2 = config.Parameters["config_2"];
processorConfig.Config3 = config.Parameters["config_3"];
}
if (processorConfig == null)
{
processorConfig = new Data.Processor.Config();
}
// Add configuration to item configuration object
itemConfig.Parameters.Add("config_1", processorConfig.Config1);
itemConfig.Parameters.Add("config_2", processorConfig.Config2);
itemConfig.Parameters.Add("config_3", processorConfig.Config3);
return(itemConfig);
}
public ActionResult <Development.SDK.Module.Data.Common.ItemConfig> Upgrade(Development.SDK.Module.Data.Common.ConfigInformation config)
{
try
{
return(Ok(_config.Upgrade(config)));
}
catch (Exception ex)
{
// EX: DEMO-0000
_logger?.Critcial("DEMO-0000", "The following error occurred while executing the processor. Error: {0}", ex.Message);
return(this.StatusCode(500, ex.Message));
}
}
/// <summary>
/// Gets the used, referenced or created items like node fields and/or language codes.
/// </summary>
/// <param name="config">The configuration information that can be used to generate the control.
/// It also contains configurations for the control that have already been saved.</param>
/// <returns></returns>
public Development.SDK.Module.Data.Common.UsedItems GetUsedItems(Development.SDK.Module.Data.Common.ConfigInformation config)
{
// Define module configuration
Data.Processor.Config processorConfig = null;
if (config != null)
{
// Get configuration
processorConfig = new Data.Processor.Config();
processorConfig.Config1 = config.Parameters["config_1"];
processorConfig.Config2 = config.Parameters["config_2"];
processorConfig.Config3 = config.Parameters["config_3"];
}
if (processorConfig == null)
{
processorConfig = new Data.Processor.Config();
}
return(processorConfig.GetUsedItems(config));
}
/// <summary>
/// Extracts the used items from the current configuration.
/// </summary>
/// <param name="config">The configuration from that the used items must be extracted.</param>
/// <returns>The used items object.</returns>
public static Development.SDK.Module.Data.Common.UsedItems GetUsedItems(this Data.Processor.Config config, Development.SDK.Module.Data.Common.ConfigInformation configInformation)
{
// Define return value
Development.SDK.Module.Data.Common.UsedItems value = null;
// Create new used items object
value = new Development.SDK.Module.Data.Common.UsedItems();
return(value);
}
/// <summary>
/// Generates the documentation.
/// </summary>
/// <param name="documentationHelper">The documentation helper.</param>
/// <param name="filter">The filter.</param>
/// <param name="showPasswords">if set to <c>true</c> [show passwords].</param>
/// <param name="item">The item.</param>
public Development.SDK.Module.Data.Document.Documentation GenerateDocumentation(Development.SDK.Module.Data.Common.ConfigInformation config, bool showPasswords, string[] filter)
{
Development.SDK.Module.Data.Document.Documentation documentation = new();
return(documentation);
}
public ActionResult <Development.SDK.Module.Data.DataQuery.QueryItem> GetItems(Development.SDK.Module.Data.Common.ConfigInformation config)
{
return(Ok(_config.GetUsedItems(config)));
}
