Msdata.SystEnumFunctionalTypes (mscmp_syst_enums v0.1.0)

The data structure defining the functional types associated with a given enumeration.

Functional types allow the application behavior associated with list choices to be decoupled from the information conveyance that the same list of choices may be able to provide. For example, the application may only need to recognize the difference between 'active' and 'inactive' order records as a status, however a user may want to see some reflection of why an order was made inactive, such as it was cancelled or that it was fulfilled. In this case would create two entries of functional type inactive, one each for cancelled and fulfilled. Functionally the application will see the same value, but user reporting can reflect the nuance not needed by the application functionality.

Defined in MscmpSystEnums.

Summary

Types

t()

Functions

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

Produces a changeset used to create or update a Enum Functional Type record.

Types

t()

@type t() :: %Msdata.SystEnumFunctionalTypes{
  __meta__: Ecto.Schema.Metadata.t(),
  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: Msdata.SystEnums.t() | Ecto.Association.NotLoaded.t() | nil,
  enum_id: Ecto.UUID.t() | nil,
  external_name: String.t() | nil,
  id: Ecto.UUID.t() | nil,
  internal_name: MscmpSystEnums.Types.enum_functional_type_name() | nil,
  syst_defined: boolean() | nil,
  syst_description: String.t() | nil,
  user_description: String.t() | nil
}

Functions

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

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

Produces a changeset used to create or update a Enum Functional Type record.

The change_params argument defines the attributes to be used in maintaining an Enum Functional Type 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.

  • external_name - A non-unique name 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_external_name_length (pos_integer/0) - Sets the minimum grapheme length of external_name values. The default value is 2.

  • :max_external_name_length (pos_integer/0) - Sets the maximum grapheme length of external_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.