Msdata.SystEnums (mscmp_syst_enums v0.1.0)

The data structure defining available system enumerations (lists of values).

Defined in MscmpSystEnums.

Summary

Types

t()

Functions

changeset(syst_enums, change_params \\ %{}, opts \\ [])

Produces a changeset used to create or update a Enumeration record.

Types

t()

@type t() :: %Msdata.SystEnums{
  __meta__: Ecto.Schema.Metadata.t(),
  default_syst_options: map() | nil,
  default_user_options: map() | nil,
  diag_role_created: String.t() | nil,
  diag_role_modified: String.t() | nil,
  diag_row_version: integer() | nil,
  diag_timestamp_created: DateTime.t() | nil,
  diag_timestamp_modified: DateTime.t() | nil,
  diag_update_count: integer() | nil,
  diag_wallclock_modified: DateTime.t() | nil,
  display_name: String.t() | nil,
  enum_items: [Msdata.SystEnumItems.t()] | Ecto.Association.NotLoaded.t() | nil,
  functional_types:
    [Msdata.SystEnumFunctionalTypes.t()] | Ecto.Association.NotLoaded.t() | nil,
  id: Ecto.UUID.t() | nil,
  internal_name: MscmpSystEnums.Types.enum_name() | nil,
  syst_defined: boolean() | nil,
  syst_description: String.t() | nil,
  user_description: String.t() | nil,
  user_maintainable: boolean() | nil
}

Functions

changeset(syst_enums, change_params \\ %{}, opts \\ [])

@spec changeset(t(), map(), Keyword.t()) :: Ecto.Changeset.t()

Produces a changeset used to create or update a Enumeration record.

The change_params argument defines the attributes to be used in maintaining an Enumerations record. Of the allowed fields, the following are required for creation:

  • internal_name - A unique key which is intended for programmatic usage by the application and other applications which make use of the data.

  • display_name - A unique key for the purposes of presentation to users in user interfaces, reporting, etc.

  • user_description - A description of the setting including its use cases and any limits or restrictions.

Options

  • :min_internal_name_length (pos_integer/0) - Sets the minimum grapheme length of internal_name values. The default value is 6.

  • :max_internal_name_length (pos_integer/0) - Sets the maximum grapheme length of internal_name values. The default value is 64.

  • :min_display_name_length (pos_integer/0) - Sets the minimum grapheme length of display_name values. The default value is 6.

  • :max_display_name_length (pos_integer/0) - Sets the maximum grapheme length of display_name values. The default value is 64.

  • :min_user_description_length (pos_integer/0) - Sets the minimum grapheme length of user_description values. The default value is 6.

  • :max_user_description_length (pos_integer/0) - Sets the maximum grapheme length of user_description values. The default value is 1000.