ElementName (MyTISM API Documentation)

java.lang.Object
- java.lang.Enum<ElementName>
- - de.ipcon.schema.ElementName

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ElementName>
```
public enum ElementName
extends java.lang.Enum<ElementName>
```
Enumerates the valid element names for a schema XML document.
Each enum constant represents a permissible element in the schema XML and provides its corresponding name as it appears in the XML file. This ensures that only predefined elements are used during XML parsing and validation.

Additionally, each element defines a set of allowed attributes via the `allowedAttributeNames` field. This further restricts the structure of the XML document by specifying which attributes are valid within each element.

Furthermore, some elements can have nested sub-elements. These are defined in the following enums:

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ENTITY` Represents the "Entity" element in the schema XML, defining a business entity.
`FOLDER` Represents the "Folder" element, defining a folder in the schema.
`GDPR_BUSINESS_INTEREST` Represents the "GDPRBusinessInterest" element, defining a GDRP related business interest in the schema that may justify the collection of data.
`GDPR_DATA_CATEGORY` Represents the "GDPRDataCategory" element, defining a GDPR classification of data in the schema according to their content and sensitivity (e.g. personal data, health data) .
`GDPR_DATA_RETENTION_POLICY` Represents the "GDPRDataRetentionPolicy" element, defining a GDRP related retention policy.
`GDPR_LAW` Represents the "GDPRLaw" element, defining a GDRP related law in the schema.
`GDPR_PROCESSING_LEGAL_BASIS` Represents the "GDPRProcessingLegalBasis" element, defining a GDRP related legal basis for data processing in the schema.
`GDPR_PROCESSING_PURPOSE` Represents the "GDPRProcessingPurpose" element, defining a GDRP related processing purpose in the schema.
`GDPR_RETENTION_PURPOSE` Represents the "GDPRRetentionPurpose" element, defining a GDRP related retention purpose.
`GENERATOR` Represents the "Generator" element, used to specify a generator class and its scope.
`INCLUDE` Represents the "Include" element, used to include external schema definitions.
`INTERFACE` Represents the "Interface" element, defining an interface in the schema.
`MODULE` Represents the "Module" element, defining a module in the schema.
`MODULE_INTEGRATOR` Represents the "ModuleIntegrator" element, specifying an integrator class for a module.
`MODULE_PROVIDER` Represents the "ModuleProvider" element, defining a provider for a module.
`TYPE` Represents the "Type" element, defining a custom type in the schema.

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Set<AttributeName>`	`allowedAttributeNames` The allowed attribute names for this element.
`java.lang.String`	`xmlName` The XML name of the element.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ElementName`	`byXmlName(java.lang.String xmlName)` Retrieves an `ElementName` by its XML name.
`static java.lang.String`	`getAllowed()` Returns a comma-separated string of all allowed XML element names.
`static ElementName`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ElementName[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ENTITY
```
public static final ElementName ENTITY
```
    Represents the "Entity" element in the schema XML, defining a business entity.
    Allowed attributes:
    - `name`: The unique name of the entity.
    - `merge`: Controls merging behavior.
    - `extends`: Specifies the parent entity to inherit from.
    - `plural`: The plural form of the entity name.
    - `abstract`: Indicates if the entity is abstract.
    - `ignoreReverseRelations`: Specifies whether to ignore reverse relationships.
    - `discriminator`: Defines a custom discriminator value.
    - `suid`: Sets a custom suid (serial version unique ID) for the entity.
    - `folder`: The folder where the entity shall be located in the navigation tree in the GUI.
    - `package`: The package associated with the entity.
    - `noAbstractWarning`: Suppresses check if an abstract entity has at least one concrete sub entity.
  - INCLUDE
```
public static final ElementName INCLUDE
```
    Represents the "Include" element, used to include external schema definitions.
    Allowed attributes:
    - `file`: The path to the external schema file.
    - `child`: Indicates if the included schema is a child schema.
  - MODULE_PROVIDER
```
public static final ElementName MODULE_PROVIDER
```
    Represents the "ModuleProvider" element, defining a provider for a module.
    Allowed attributes:
    - `name`: The name of the module provider.
    - `path`: The path associated with the module provider.
  - MODULE_INTEGRATOR
```
public static final ElementName MODULE_INTEGRATOR
```
    Represents the "ModuleIntegrator" element, specifying an integrator class for a module.
    Allowed attributes:
    - `class`: The fully qualified name of the integrator class.
  - MODULE
```
public static final ElementName MODULE
```
    Represents the "Module" element, defining a module in the schema.
    Allowed attributes:
    - `name`: The name of the module.
    - `provider`: The name of the module provider.
  - GENERATOR
```
public static final ElementName GENERATOR
```
    Represents the "Generator" element, used to specify a generator class and its scope.
    Allowed attributes:
    - `class`: The fully qualified name of the generator class.
    - `scope`: The scope of the generator. All values other than "local" will be interpreted as a global scope.
  - FOLDER
```
public static final ElementName FOLDER
```
    Represents the "Folder" element, defining a folder in the schema.
    Allowed attributes:
    - `path`: The path of the folder.
  - TYPE
```
public static final ElementName TYPE
```
    Represents the "Type" element, defining a custom type in the schema.
    Allowed attributes:
    - `name`: The name of the custom type.
    - `class`: The fully qualified name of the class representing the type.
    - `extends`: The parent type to inherit from.
  - INTERFACE
```
public static final ElementName INTERFACE
```
    Represents the "Interface" element, defining an interface in the schema.
    Allowed attributes:
    - `name`: The name of the interface.
  - GDPR_DATA_CATEGORY
```
public static final ElementName GDPR_DATA_CATEGORY
```
    Represents the "GDPRDataCategory" element, defining a GDPR classification of data in the schema according to their content and sensitivity (e.g. personal data, health data) .
    Allowed attributes:
    - `id`: The unique identifier of the data category.
    - `title`: A descriptive title of the data category (optional).
    Allowed sub-elements:
    - DataCategorySubelementName
  - GDPR_BUSINESS_INTEREST
```
public static final ElementName GDPR_BUSINESS_INTEREST
```
    Represents the "GDPRBusinessInterest" element, defining a GDRP related business interest in the schema that may justify the collection of data.
    Allowed attributes:
    - `id`: The unique identifier of the business interest.
  - GDPR_PROCESSING_PURPOSE
```
public static final ElementName GDPR_PROCESSING_PURPOSE
```
    Represents the "GDPRProcessingPurpose" element, defining a GDRP related processing purpose in the schema.
    Allowed attributes:
    - `id`: The unique identifier of the processing purpose.
    Allowed sub-elements:
    - ProcessingPurposeSubelementName
  - GDPR_PROCESSING_LEGAL_BASIS
```
public static final ElementName GDPR_PROCESSING_LEGAL_BASIS
```
    Represents the "GDPRProcessingLegalBasis" element, defining a GDRP related legal basis for data processing in the schema.
    Allowed attributes:
    - `id`: The unique identifier of the legal basis.
  - GDPR_LAW
```
public static final ElementName GDPR_LAW
```
    Represents the "GDPRLaw" element, defining a GDRP related law in the schema.
    Allowed attributes:
    - `id`: The unique identifier of the law.
    - `paragraph`: The legal paragraph or article of the law (e.g. “Art. 6 para. 1 lit. b GDPR”).
    - `country`: The ISO code of the country in which the law applies.
    - `url`: The URL that refers to the legal text (optional).
  - GDPR_RETENTION_PURPOSE
```
public static final ElementName GDPR_RETENTION_PURPOSE
```
    Represents the "GDPRRetentionPurpose" element, defining a GDRP related retention purpose.
    Allowed attributes:
    - `id`: The unique identifier of the retention purpose.
  - GDPR_DATA_RETENTION_POLICY
```
public static final ElementName GDPR_DATA_RETENTION_POLICY
```
    Represents the "GDPRDataRetentionPolicy" element, defining a GDRP related retention policy.
    Allowed attributes:
    - `country`: The ISO code of the country in which the data retention requirements apply.
    - `category`: The Id of the data category to which the retention period applies.
    - `duration`: The duration of the retention period (e.g. “10y”).
    - `start`: The starting time of the retention period (e.g. “custom”, “calendar_year_end”).
    - `trigger`: The event that triggers the retention period (e.g. “termination”).
    - `evaluationFrequency`: The frequency with which the data is checked (e.g. “annually”).
    - `lastAssessmentDate`: The date of the last assessment of the retention period and data protection measures in the format “YYYY-MM-DD”.
    - `rightsAndFreedomsAssessed`: The confirmation that the rights and freedoms of data subjects were taken into account when determining or last assessing the retention period. Example: “true”.
    Allowed sub-elements:
    - DataRetentionPolicySubelementName
- Field Detail
  - xmlName
```
public final java.lang.String xmlName
```
    The XML name of the element.
  - allowedAttributeNames
```
public final java.util.Set<AttributeName> allowedAttributeNames
```
    The allowed attribute names for this element.
- Method Detail
  - values
```
public static ElementName[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ElementName c : ElementName.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ElementName valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - byXmlName
```
public static ElementName byXmlName(java.lang.String xmlName)
```
    Retrieves an `ElementName` by its XML name.
    
    Parameters:
    
    xmlName - The XML name of the element.
    
    Returns:
    
    The corresponding `ElementName`, or null if not found.
  - getAllowed
```
public static java.lang.String getAllowed()
```
    Returns a comma-separated string of all allowed XML element names.
    
    Returns:
    
    A comma-separated string of allowed element names.

Enum ElementName

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ENTITY

INCLUDE

MODULE_PROVIDER

MODULE_INTEGRATOR

MODULE

GENERATOR

FOLDER

TYPE

INTERFACE

GDPR_DATA_CATEGORY

GDPR_BUSINESS_INTEREST

GDPR_PROCESSING_PURPOSE

GDPR_PROCESSING_LEGAL_BASIS

GDPR_LAW

GDPR_RETENTION_PURPOSE

GDPR_DATA_RETENTION_POLICY

Field Detail

xmlName

allowedAttributeNames

Method Detail

values

valueOf

byXmlName

getAllowed