@spec create_setting(MscmpSystSettings.Types.setting_params()) ::
  :ok | {:error, MscmpSystError.t()}

Creates a new user defined setting.

This function creates a setting which is automatically marked as being user defined. User created settings such as those created by this function are the only kind of settings which may be deleted via delete_setting/2.

Parameters

• creation_paramsa map defining the new settings record. The map must contain the following keys:

  • internal_name - This is the unique value which represents the name of the setting and is used for latter lookup of setting values. This key should be suitable for programmatic references to the setting.

  • display_name - A unique value used to display the setting name in user interface contexts.

  • user_description - A user visible description of the setting including information describing how the setting is used in the application and directions for correct usage. Currently, the description must be at least 6 characters long.

  other allowed values, such as the setting values themselves, are also permitted here, but not required.

Examples

iex> new_setting = %{
...>   internal_name: "create_example_setting",
...>   display_name: "Create Example Setting",
...>   user_description: "An example of setting creation.",
...>   setting_integer: 9876
...> }
iex> MscmpSystSettings.create_setting(new_setting)
:okcopy

@spec delete_setting(MscmpSystSettings.Types.setting_name()) ::
  :ok | {:error, MscmpSystError.t()}

Deletes the named user defined setting from the system.

Note that this function cannot be used to delete a system defined setting. Trying to do so will result in a error being raised.

Parameters

• setting_name - the name of the setting should be deleted.

Examples

iex> MscmpSystSettings.delete_setting("delete_example_setting")
:okcopy

@spec get_setting_value(
  MscmpSystSettings.Types.setting_name(),
  MscmpSystSettings.Types.setting_types()
) :: any()

Retrieves the value of the given type for the requested setting.

Parameters

• setting_name - the name of the setting for which to retrieve a value.

• setting_type - the type of value which to return.

Examples

iex> MscmpSystSettings.get_setting_value(
...>   "get_example_setting",
...>   :setting_decimal_range)
%MscmpSystDb.DbTypes.DecimalRange{
  lower: Decimal.new("1.1"),
  upper: Decimal.new("99.99"),
  lower_inclusive: true,
  upper_inclusive: false
}copy

@spec get_setting_values(MscmpSystSettings.Types.setting_name()) ::
  Msdata.SystSettings.t()

Retrieves all values associated with the requested setting.

Parameters

• setting_name - the name of the setting for which to retrieve values.

The successful return of this function is an instance of the Msdata.SystSettings struct containing the values requested.

Examples

iex> MscmpSystSettings.get_setting_values("get_example_setting")copy

@spec list_all_settings() :: [Msdata.SystSettings]

Retrieves all values for all settings.

This function returns all other setting metadata, such as the records' IDs, descriptions, etc.

Examples

iex> MscmpSystSettings.list_all_settings()copy

@spec set_setting_value(
  MscmpSystSettings.Types.setting_name(),
  MscmpSystSettings.Types.setting_types(),
  any()
) :: :ok | {:error, MscmpSystError.t()}

Sets the value of any one setting type for the named setting.

Parameters

• setting_name - the name of the setting to update with the new value.

• setting_type - sets which of the different available value types is being updated.

• setting_value - is the new value to set on the setting. Note that the setting value must be appropriate for the setting_type argument or an error will be raised.

Examples

iex> MscmpSystSettings.set_setting_value(
...>   "set_example_setting",
...>   :setting_decimal,
...>   Decimal.new("1029.3847"))
:okcopy

@spec set_setting_values(
  MscmpSystSettings.Types.setting_name(),
  MscmpSystSettings.Types.setting_service_params()
) :: :ok | {:error, MscmpSystError.t()}

Sets one or more of the available setting types for the named setting.

This function is similar to set_setting_values/4, except that multiple setting types can have their values set at the same time. In addition to the typed setting values, the setting display name and/or user description values may also be set.

Parameters

• setting_name - the name of the setting to update with the new values.

• update_params - is a map that complies with the MscmpSystSettings.Types.setting_service_params() type specification and includes the updates to setting type values, updates to the display_name value, and/or updates to the user_description value.

Examples

iex> update_values = %{
...>   user_description: "An example of updating the user description.",
...>   setting_integer: 6758,
...>   setting_date_range:
...>      %MscmpSystDb.DbTypes.DateRange{
...>        lower: ~D[2022-04-01],
...>        upper: ~D[2022-04-12],
...>        upper_inclusive: true
...>      }
...> }
iex> MscmpSystSettings.set_setting_values(
...>   "set_example_setting",
...>   update_values)
:okcopy