DataRetentionPolicy (MyTISM API Documentation)

java.lang.Object
- de.ipcon.schema.gdpr.GDPRConfigurationElement
- - de.ipcon.schema.gdpr.DataRetentionPolicy

All Implemented Interfaces:

GDPRConfigurationElementI
```
public class DataRetentionPolicy
extends GDPRConfigurationElement
```
Represents a data retention policy within the GDPR (General Data Protection Regulation) configuration.
This class defines a specific policy for retaining personal data, including the country, data category, duration, start date, trigger, evaluation frequency, last assessment date, and whether rights and freedoms have been assessed. It also includes a collection of associated law Ids to support the policy.

The `trigger` attribute defines the event that initiates the retention period (e.g., contract conclusion, last activity). The `evaluationFrequency` attribute specifies how often the retention policy should be evaluated and applied.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String LAST_ASSESSMENT_DATE_STRING

static java.lang.String TIMEZONE_ID_LUXEMBOURG

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`LAST_ASSESSMENT_DATE_STRING`
`static java.lang.String`	`TIMEZONE_ID_LUXEMBOURG`

Constructor Summary

Constructors
Constructor and Description
`DataRetentionPolicy(electric.xml.Element element, java.lang.String categoryId)` Constructs a `DataRetentionPolicy` with the specified details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLaw(java.lang.String lawId)` Adds a law Id to this data retention policy.
`DataCategory`	`getCategory()` Returns the data category this policy applies to.
`java.lang.String`	`getCountryISOCode()` Returns the ISO code of the country for which this policy applies or "EU" for the European Union.
`DataRetentionEvaluationFrequency`	`getEvaluationFrequency()` Returns the frequency at which the data retention policy is (re)evaluated.
`GDPRArea`	`getGDPRArea()` Returns the GDPR area where this policy applies.
`java.util.Date`	`getLastAssessmentDate()` Returns the date of the last assessment of the data retention policy.
`java.util.Collection<Law>`	`getLaws()` Returns the collection of laws associated with this data retention policy.
`java.time.Period`	`getPeriod()` Returns the the data retention period.
`DataRetentionStart`	`getStart()` Returns the start of the data retention period.
`DataRetentionTrigger`	`getTrigger()` Returns the trigger for initiating the data retention period.
`boolean`	`isRightsAndFreedomsAssessed()` Indicates whether the rights and freedoms of data subjects have been assessed for this policy.
`void`	`linkAndValidateGDPRObjects()` Links and validates the GDPR configuration elements.
`void`	`setEvaluationFrequency(DataRetentionEvaluationFrequency evaluationFrequency)` Sets the evaluation frequency for the policy.
`void`	`setGDPRArea(GDPRArea gDPRArea)` Sets the area of data retention for this policy.
`void`	`setLastAssessmentDate(java.util.Date lastAssessmentDate)` Sets the last assessment date of data retention.
`void`	`setPeriod(java.time.Period period)` Sets the data retention period for this policy.
`void`	`setRightsAndFreedomsAssessed(boolean rightsAndFreedomsAssessed)` Sets the rightsAndFreedomsAssessed state of data retention.
`void`	`setStart(DataRetentionStart start)` Sets the data retention start for this policy.
`void`	`setTrigger(DataRetentionTrigger trigger)` Sets the trigger for initiating the retention period of this policy.
`java.lang.String`	`toString()` Returns a string representation of this GDPR configuration element.

Methods inherited from class de.ipcon.schema.gdpr.GDPRConfigurationElement
getEl, releaseDefinitionSource

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

- Field Detail
  - LAST_ASSESSMENT_DATE_STRING
```
public static final java.lang.String LAST_ASSESSMENT_DATE_STRING
```
    See Also:
    
    Constant Field Values
  - TIMEZONE_ID_LUXEMBOURG
```
public static final java.lang.String TIMEZONE_ID_LUXEMBOURG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataRetentionPolicy
```
public DataRetentionPolicy(electric.xml.Element element,
                           java.lang.String categoryId)
```
    Constructs a `DataRetentionPolicy` with the specified details.
    
    Parameters:
    
    element - The XML element representing this data retention policy.
    
    categoryId - The Id of the data category.
- Method Detail
  - setGDPRArea
```
public void setGDPRArea(GDPRArea gDPRArea)
```
    Sets the area of data retention for this policy.
    
    Parameters:
    
    gDPRArea - The GDPR area to set.
  - setPeriod
```
public void setPeriod(java.time.Period period)
```
    Sets the data retention period for this policy.
    
    Parameters:
    
    period - The period to set.
  - setStart
```
public void setStart(DataRetentionStart start)
```
    Sets the data retention start for this policy.
    
    Parameters:
    
    start - The start to set.
  - setTrigger
```
public void setTrigger(DataRetentionTrigger trigger)
```
    Sets the trigger for initiating the retention period of this policy.
    
    Parameters:
    
    trigger - The trigger to set.
  - setEvaluationFrequency
```
public void setEvaluationFrequency(DataRetentionEvaluationFrequency evaluationFrequency)
```
    Sets the evaluation frequency for the policy.
    
    Parameters:
    
    evaluationFrequency - The evaluation frequency to set.
  - setLastAssessmentDate
```
public void setLastAssessmentDate(java.util.Date lastAssessmentDate)
```
    Sets the last assessment date of data retention.
    
    Parameters:
    
    lastAssessmentDate - The last assessment date to set.
  - setRightsAndFreedomsAssessed
```
public void setRightsAndFreedomsAssessed(boolean rightsAndFreedomsAssessed)
```
    Sets the rightsAndFreedomsAssessed state of data retention.
    
    Parameters:
    
    rightsAndFreedomsAssessed - A boolean representing if rights and freedoms were assessed.
  - addLaw
```
public void addLaw(java.lang.String lawId)
```
    Adds a law Id to this data retention policy.
    
    Parameters:
    
    lawId - The Id of the law to add.
  - linkAndValidateGDPRObjects
```
public void linkAndValidateGDPRObjects()
```
    Links and validates the GDPR configuration elements.
    This method performs two key functions:
    1. Linking: Resolves references to other GDPR configuration elements by their Ids, establishing the necessary relationships between them.
    2. Validation: Ensures the integrity of the configuration by checking the existence and validity of all linked elements. This helps to maintain a robust and error-free GDPR configuration.
    Subclasses must provide a concrete implementation for this method to perform the necessary linking and validation checks.
    
    This implementation also verifies that the referenced data category and all referenced laws exist.
    Specified by:
    
    linkAndValidateGDPRObjects in interface GDPRConfigurationElementI
    
    Specified by:
    
    linkAndValidateGDPRObjects in class GDPRConfigurationElement
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this GDPR configuration element.
    This method provides a human-readable representation of the configuration element, typically including its key properties and any relevant information for debugging or logging purposes.
    
    This implementation includes all relevant details of the data retention policy in the string representation.
    
    Specified by:
    
    toString in interface GDPRConfigurationElementI
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this GDPR configuration element.
  - getGDPRArea
```
public GDPRArea getGDPRArea()
```
    Returns the GDPR area where this policy applies.
    
    Returns:
    
    The GDPR area where this policy applies.
  - getCountryISOCode
```
public java.lang.String getCountryISOCode()
```
    Returns the ISO code of the country for which this policy applies or "EU" for the European Union.
    
    Returns:
    
    The ISO code of the country or "EU" for the European Union.
  - getCategory
```
public DataCategory getCategory()
```
    Returns the data category this policy applies to.
    
    Returns:
    
    The data category.
  - getPeriod
```
public java.time.Period getPeriod()
```
    Returns the the data retention period.
    
    Returns:
    
    The data retention period.
  - getStart
```
public DataRetentionStart getStart()
```
    Returns the start of the data retention period.
    
    Returns:
    
    The start of the retention period.
  - getTrigger
```
public DataRetentionTrigger getTrigger()
```
    Returns the trigger for initiating the data retention period.
    
    Returns:
    
    The trigger for initiating the retention period.
  - getEvaluationFrequency
```
public DataRetentionEvaluationFrequency getEvaluationFrequency()
```
    Returns the frequency at which the data retention policy is (re)evaluated.
    
    Returns:
    
    The (re)evaluation frequency of the policy.
  - getLastAssessmentDate
```
public java.util.Date getLastAssessmentDate()
```
    Returns the date of the last assessment of the data retention policy.
    
    Returns:
    
    The date of the last assessment.
  - isRightsAndFreedomsAssessed
```
public boolean isRightsAndFreedomsAssessed()
```
    Indicates whether the rights and freedoms of data subjects have been assessed for this policy.
    
    Returns:
    
    true if rights and freedoms have been assessed, false otherwise.
  - getLaws
```
public java.util.Collection<Law> getLaws()
```
    Returns the collection of laws associated with this data retention policy.
    
    Returns:
    
    The collection of Law objects.

Class DataRetentionPolicy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.ipcon.schema.gdpr.GDPRConfigurationElement

Methods inherited from class java.lang.Object

Field Detail

LAST_ASSESSMENT_DATE_STRING

TIMEZONE_ID_LUXEMBOURG

Constructor Detail

DataRetentionPolicy

Method Detail

setGDPRArea

setPeriod

setStart

setTrigger

setEvaluationFrequency

setLastAssessmentDate

setRightsAndFreedomsAssessed

addLaw

linkAndValidateGDPRObjects

toString

getGDPRArea

getCountryISOCode

getCategory

getPeriod

getStart

getTrigger

getEvaluationFrequency

getLastAssessmentDate

isRightsAndFreedomsAssessed

getLaws