AttributeName (MyTISM API Documentation)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AttributeName>
```
public enum AttributeName
extends java.lang.Enum<AttributeName>
```
Enumerates the valid attribute names for elements in a schema XML document.
This enum defines a common pool of attribute names that can be used across various elements in the schema, promoting consistency and reducing code duplication. Each enum constant represents an attribute and holds its corresponding XML name, which is the actual name used in the XML file.

This design avoids the need for nested enums within each `ElementName`, which would lead to redundant code for constructors, fields, and methods. By centralizing attribute definitions in a single enum, we ensure that each attribute is defined only once and can be easily reused across different elements.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABSTRACT` Represents the "abstract" attribute, indicating that an entity is abstract and objects of that type cannot be persisted.
`CATEGORY` Represents the "category" attribute, defining the Id of the data category to which the retention period applies.
`CHILD` Represents the "child" attribute, indicating whether an included schema is considered a child schema.
`CLASS` Represents the "class" attribute, used to define the class associated with an element.
`COUNTRY` Represents the "country" attribute, used to assign a country to an element, e.g. the ISO code of the country in which a law or the data retention requirements apply.
`DISCRIMINATOR` Represents the "discriminator" attribute, used to define a custom discriminator value.
`EVALUATION_FREQUENCY` Represents the "evaluationFrequency" attribute, defining the frequency with which the data is checked (e.g.
`EXTENDS` Represents the "extends" attribute, used to specify inheritance relationships between types or entities.
`FILE` Represents the "file" attribute, specifying the path to an external schema file to be included.
`FOLDER` Represents the "folder" attribute, indicating the folder where the entity shall be located in the navigation tree in the GUI.
`ID` Represents the "id" attribute, used to assign a unique identifier to an element.
`IGNORE_REVERSE_RELATIONS` Represents the "ignoreReverseRelations" attribute, used to specify whether reverse relationships should be ignored for an entity.
`LANGUAGE` Represents the "language" attribute, typically used in the root element to specify the scripting language of the schema.
`LAST_ASSESSMENT_DATE` Represents the "lastAssessmentDate" attribute, defining the date of the last assessment of the retention period and data protection measures in the format “YYYY-MM-DD”.
`MERGE` Represents the "merge" attribute, used to control how entities are merged during schema processing.
`MERGE_L10N` Represents the "mergeL10n" attribute, used to control the merging of localization data for a module.
`NAME` Represents the "name" attribute, used to assign a name to an element.
`NO_ABSTRACT_WARNING` Represents the "noAbstractWarning" attribute, used to suppress checks if an abstract entity has at least one concrete sub entity.
`PACKAGE` Represents the "package" attribute, specifying the package associated with an entity.
`PARAGRAPH` Represents the "paragraph" attribute, defining the legal paragraph or article of the law (e.g.
`PATH` Represents the "path" attribute, specifying a file path or directory.
`PERIOD` Represents the "period" attribute, defining the data retention period (e.g. “10y”).
`PLURAL` Represents the "plural" attribute, used to define the plural form of an entity name.
`PROVIDER` Represents the "provider" attribute, specifying the module provider for a module.
`RIGHTS_AND_FREEDOMS_ASSESSED` Represents the "rightsAndFreedomsAssessed" attribute, defining the confirmation that the rights and freedoms of data subjects were taken into account when determining or last assessing the retention period.
`SCOPE` Represents the "scope" attribute, defining the scope of a generator.
`START` Represents the "start" attribute, defining the starting time of the retention period (e.g.
`SUID` Represents the "suid" attribute, used to set a custom suid (serial version unique ID) for an entity.
`TITLE` Represents the "title" attribute, used to assign a descriptive title to an element.
`TRIGGER` Represents the "trigger" attribute, defining the event that triggers the retention period (e.g.
`URL` Represents the "url" attribute, defining the URL that refers to the legal text.

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String xmlName
The XML name of the attribute.

Fields
Modifier and Type	Field and Description
`java.lang.String`	`xmlName` The XML name of the attribute.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AttributeName`	`byXmlName(java.lang.String xmlName)` Retrieves an `AttributeName` by its XML name.
`static java.lang.String`	`getAllowed()` Returns a comma-separated string of all allowed XML attribute names.
`static AttributeName`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static AttributeName[]`	`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
  - LANGUAGE
```
public static final AttributeName LANGUAGE
```
    Represents the "language" attribute, typically used in the root element to specify the scripting language of the schema.
  - MERGE
```
public static final AttributeName MERGE
```
    Represents the "merge" attribute, used to control how entities are merged during schema processing.
  - PLURAL
```
public static final AttributeName PLURAL
```
    Represents the "plural" attribute, used to define the plural form of an entity name.
  - ABSTRACT
```
public static final AttributeName ABSTRACT
```
    Represents the "abstract" attribute, indicating that an entity is abstract and objects of that type cannot be persisted.
  - IGNORE_REVERSE_RELATIONS
```
public static final AttributeName IGNORE_REVERSE_RELATIONS
```
    Represents the "ignoreReverseRelations" attribute, used to specify whether reverse relationships should be ignored for an entity.
  - DISCRIMINATOR
```
public static final AttributeName DISCRIMINATOR
```
    Represents the "discriminator" attribute, used to define a custom discriminator value.
  - SUID
```
public static final AttributeName SUID
```
    Represents the "suid" attribute, used to set a custom suid (serial version unique ID) for an entity.
  - FOLDER
```
public static final AttributeName FOLDER
```
    Represents the "folder" attribute, indicating the folder where the entity shall be located in the navigation tree in the GUI.
  - PACKAGE
```
public static final AttributeName PACKAGE
```
    Represents the "package" attribute, specifying the package associated with an entity.
  - NO_ABSTRACT_WARNING
```
public static final AttributeName NO_ABSTRACT_WARNING
```
    Represents the "noAbstractWarning" attribute, used to suppress checks if an abstract entity has at least one concrete sub entity.
  - FILE
```
public static final AttributeName FILE
```
    Represents the "file" attribute, specifying the path to an external schema file to be included.
  - CHILD
```
public static final AttributeName CHILD
```
    Represents the "child" attribute, indicating whether an included schema is considered a child schema.
  - PROVIDER
```
public static final AttributeName PROVIDER
```
    Represents the "provider" attribute, specifying the module provider for a module.
  - MERGE_L10N
```
public static final AttributeName MERGE_L10N
```
    Represents the "mergeL10n" attribute, used to control the merging of localization data for a module.
  - SCOPE
```
public static final AttributeName SCOPE
```
    Represents the "scope" attribute, defining the scope of a generator.
  - PARAGRAPH
```
public static final AttributeName PARAGRAPH
```
    Represents the "paragraph" attribute, defining the legal paragraph or article of the law (e.g. “Art. 6 para. 1 lit. b GDPR”).
  - URL
```
public static final AttributeName URL
```
    Represents the "url" attribute, defining the URL that refers to the legal text.
  - CATEGORY
```
public static final AttributeName CATEGORY
```
    Represents the "category" attribute, defining the Id of the data category to which the retention period applies.
  - PERIOD
```
public static final AttributeName PERIOD
```
    Represents the "period" attribute, defining the data retention period (e.g. “10y”).
  - START
```
public static final AttributeName START
```
    Represents the "start" attribute, defining the starting time of the retention period (e.g. “custom”, “calendar_year_end”).
  - TRIGGER
```
public static final AttributeName TRIGGER
```
    Represents the "trigger" attribute, defining the event that triggers the retention period (e.g. “termination”).
  - EVALUATION_FREQUENCY
```
public static final AttributeName EVALUATION_FREQUENCY
```
    Represents the "evaluationFrequency" attribute, defining the frequency with which the data is checked (e.g. “annually”).
  - LAST_ASSESSMENT_DATE
```
public static final AttributeName LAST_ASSESSMENT_DATE
```
    Represents the "lastAssessmentDate" attribute, defining the date of the last assessment of the retention period and data protection measures in the format “YYYY-MM-DD”.
  - RIGHTS_AND_FREEDOMS_ASSESSED
```
public static final AttributeName RIGHTS_AND_FREEDOMS_ASSESSED
```
    Represents the "rightsAndFreedomsAssessed" attribute, defining the confirmation that the rights and freedoms of data subjects were taken into account when determining or last assessing the retention period. Example: “true”.
  - EXTENDS
```
public static final AttributeName EXTENDS
```
    Represents the "extends" attribute, used to specify inheritance relationships between types or entities.
  - CLASS
```
public static final AttributeName CLASS
```
    Represents the "class" attribute, used to define the class associated with an element.
  - PATH
```
public static final AttributeName PATH
```
    Represents the "path" attribute, specifying a file path or directory.
  - NAME
```
public static final AttributeName NAME
```
    Represents the "name" attribute, used to assign a name to an element.
  - ID
```
public static final AttributeName ID
```
    Represents the "id" attribute, used to assign a unique identifier to an element.
  - TITLE
```
public static final AttributeName TITLE
```
    Represents the "title" attribute, used to assign a descriptive title to an element.
  - COUNTRY
```
public static final AttributeName COUNTRY
```
    Represents the "country" attribute, used to assign a country to an element, e.g. the ISO code of the country in which a law or the data retention requirements apply.
- Field Detail
  - xmlName
```
public final java.lang.String xmlName
```
    The XML name of the attribute.
- Method Detail
  - values
```
public static AttributeName[] 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 (AttributeName c : AttributeName.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AttributeName 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 AttributeName byXmlName(java.lang.String xmlName)
```
    Retrieves an `AttributeName` by its XML name.
    
    Parameters:
    
    xmlName - The XML name of the attribute.
    
    Returns:
    
    The corresponding `AttributeName`, or null if not found.
  - getAllowed
```
public static java.lang.String getAllowed()
```
    Returns a comma-separated string of all allowed XML attribute names.
    
    Returns:
    
    A comma-separated string of allowed attribute names.

Enum AttributeName

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LANGUAGE

MERGE

PLURAL

ABSTRACT

IGNORE_REVERSE_RELATIONS

DISCRIMINATOR

SUID

FOLDER

PACKAGE

NO_ABSTRACT_WARNING

FILE

CHILD

PROVIDER

MERGE_L10N

SCOPE

PARAGRAPH

URL

CATEGORY

PERIOD

START

TRIGGER

EVALUATION_FREQUENCY

LAST_ASSESSMENT_DATE

RIGHTS_AND_FREEDOMS_ASSESSED

EXTENDS

CLASS

PATH

NAME

ID

TITLE

COUNTRY

Field Detail

xmlName

Method Detail

values

valueOf

byXmlName

getAllowed