élément enumeration

Modèle de contenu

enumeration:==(help| value)

Attributs

• @basetype (string)
• @default (string)
• @desc (string)
• @label (string)
• @name (string)
• @template (string)

Parents

<srcschema>

Enfants

• <help>
• <value>

Description

Cet élément permet de définir une énumération de valeurs. Une énumération appartient au schéma dans laquelle elle est définie mais elle reste accessible depuis un autre schéma.

Usage et contexte d'utilisation

Une énumération se définit au tout début d'un schéma (avant la définition de l'élément principal).

Description des attributs

• basetype (string): type des valeurs stockées dans l'énumération.

  Liste des types disponibles :

  • ANY
  • bin
  • blob
  • boolean
  • byte
  • CDATA
  • datetime
  • datetimetz
  • datetimenotz
  • date
  • DOMDocument
  • DOMElement
  • double
  • enum
  • float
  • html
  • int64
  • link
  • long
  • memo
  • MNTOKEN
  • percent
  • primarykey
  • short
  • string
  • time
  • timespan
  • uuid

• default (string): valeur par défaut. La valeur par défaut peut aussi être une des valeurs définies dans l'énumération.

• desc (string): description de l'énumération.

• label (string): libellé de l'énumération.

• name (string): nom interne de l'énumération.

• template (string) : cet attribut définit une référence à un élément <enumeration> partagé par plusieurs schémas. La définition est automatiquement copiée dans le schéma actuel.

Exemples

Exemple d'énumération dont les valeurs sont stockées en base:

    <enumeration name="myEnum">
       <value name="One" value="1"/>
       <value name="Two" value="2"/>
    </enumeration>

    <element label="Sample" name="Sample">
       <attribute dbEnum="myEnum" length="100" name="Number" required="true" type="string"/>
    </element>

Définition d'un énumération avec une valeur par défaut:

 <enumeration basetype="byte" default="email" name="canal">
    <value label="Email" name="email" value="0"/>
    <value label="Téléphone" name="phone" value="1"/>
    <value label="Call Center" name="callcenter" value="2"/>
 </enumeration>