@spec create_enum(MscmpSystEnums.Types.enum_params()) ::
  :ok | {:error, MscmpSystError.t()}

Create a new user defined enumeration, optionally including functional type and enumeration item definitions.

Parameters

• enum_params - a map containing the enumeration field values used in creating the user defined enumerations. If the enumeration's functional types and enumeration items are known at enumeration creation time, it is recommended to nest values for those records under the functional_types and enum_items attributes as appropriate. See the documentation for MscmpSystEnums.Types.enum_params/0, MscmpSystEnums.Types.enum_functional_type_params/0, and MscmpSystEnums.Types.enum_item_params/0 for more information about the available and required attributes.

Examples

iex> example_enumeration =
...>   %{
...>      internal_name: "example_create_enum",
...>      display_name: "Create Example Enum",
...>      user_description: "Demonstrate enumeration creation.",
...>      functional_types: [
...>        %{
...>          internal_name: "example_create_enum_functional_type",
...>          display_name: "Create Example Enum / Functional Type",
...>          external_name: "Functional Type",
...>          user_description: "Demonstrate Functional Type Creation"
...>        }
...>      ],
...>      enum_items: [
...>        %{
...>          internal_name: "example_create_enum_item",
...>          display_name: "Create Example Enum / Enum Item",
...>          external_name: "Enum Item",
...>          user_description: "Demonstration of enumeration item creation.",
...>          enum_default: true,
...>          functional_type_default: false,
...>          functional_type_name: "example_create_enum_functional_type"
...>        }
...>      ]
...>    }
iex> MscmpSystEnums.create_enum(example_enumeration)
:okcopy

@spec delete_enum(MscmpSystEnums.Types.enum_name()) ::
  :ok | {:error, MscmpSystError.t()}

Deletes a user defined enumeration and its child functional type and enumeration item records.

You cannot delete a system defined enumeration nor can you delete an enumeration that has been referenced in other application data records.

Parameters

• enum_name - the enumeration which is to be deleted by the function.

@spec get_enum_syst_defined(MscmpSystEnums.Types.enum_name()) :: boolean()

Returns true if the requested enumeration is system defined, false otherwise.

Parameters

• enum_name - the name of the enumeration to test as being system defined.

Examples

iex> MscmpSystEnums.get_enum_syst_defined("example_enumeration")
falsecopy

@spec get_enum_user_maintainable(MscmpSystEnums.Types.enum_name()) :: boolean()

Returns true if the requested enumeration is user maintainable, false otherwise.

Parameters

• enum_name - the name of the enumeration to test as being user maintainable.

Examples

iex> MscmpSystEnums.get_enum_user_maintainable( "example_enumeration")
truecopy

@spec get_enum_values(MscmpSystEnums.Types.enum_name()) :: Msdata.SystEnums.t()

Retrieves all values associated with the requested enumeration.

Parameters

• enum_name - indicates the name of the enumeration for which to retrieve values.

The successful return of this function is an instance of the Msdata.SystEnums struct containing the values requested, including the enum_items association populated as well as each item's functional_type association populated.

Examples

iex> MscmpSystEnums.get_enum_values("example_enumeration")copy

@spec list_all_enums() :: [Msdata.SystEnums.t()]

Retrieves all values for all enumerations.

This function returns all other enumeration metadata, such as the records' IDs, descriptions, etc. Also included is association data for the enum_items field and the functional_type association of each item.

Examples

iex> MscmpSystEnums.list_all_enums()

@spec set_enum_values(
  MscmpSystEnums.Types.enum_name(),
  MscmpSystEnums.Types.enum_params()
) ::
  :ok | {:error, MscmpSystError.t()}

Changes the values of an existing enumeration.

You can change the following fields using the this function:

• internal_name - Note that you cannot change the internal name of a system defined enumeration.

• display_name

• user_description

• default_user_options

Other fields of the Msdata.SystEnums data type may not be modified via this module. Also note that only the enumeration value itself can be modified. Changes to functional type or enumeration item records must be addressed individually.

Parameters

• enum_name - the enumeration which is being modified.

• enum_params - a map of type MscmpSystEnums.Types.enum_params/0 which establishes the data values which are to be changed.