All Implemented Interfaces:

android.os.Parcelable , io.didomi.sdk.models.DataProcessing , io.didomi.sdk.models.Namespaceable
```
public final class InternalPurpose
 implements DataProcessing, Namespaceable
                    
```
Model class for purposes

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`PERSONAL_DATA_TYPE`
`private transient PurposeCategory`	`category`
`private final String`	`id`
`private final String`	`iabId`
`private String`	`name`
`private String`	`description`
`private String`	`descriptionLegal`
`private List<String>`	`illustrations`
`private transient Boolean`	`isConsent`
`private transient Boolean`	`isEssential`
`private transient Boolean`	`isLegitimateInterest`
`private transient Boolean`	`isSpecialFeature`
`private final DataProcessingNamespaces`	`namespaces`

Constructor Summary

Constructors
Constructor	Description
`InternalPurpose(String id, String iabId, String name, String description, String descriptionLegal, List<String> illustrations, Boolean isConsent, Boolean isEssential, Boolean isLegitimateInterest, Boolean isSpecialFeature, String type, DataProcessingNamespaces namespaces, Boolean iabConsentRequired, Boolean iabLiRequired, Boolean isFirstPartyConsent, Boolean isFirstPartyLi)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final PurposeCategory`	`getCategory()`
`final Unit`	`setCategory(PurposeCategory category)`
`String`	`getId()`	Purpose id used internally by Didomi.
`String`	`getIabId()`	Purpose id as defined by IAB.
`String`	`getName()`	Purpose human-readable name or translation key.
`Unit`	`setName(@SerializedName(value = "name") String name)`	Purpose human-readable name or translation key.
`String`	`getDescription()`	Purpose description.
`Unit`	`setDescription(@SerializedName(value = "description") String description)`	Purpose description.
`String`	`getDescriptionLegal()`	Purpose legal description.
`Unit`	`setDescriptionLegal(@SerializedName(value = "descriptionLegal") String descriptionLegal)`	Purpose legal description.
`List<String>`	`getIllustrations()`	Purpose illustrations.
`Unit`	`setIllustrations(@SerializedName(value = "illustrations") List<String> illustrations)`	Purpose illustrations.
`final Boolean`	`isConsent()`	Whether the purpose is used as a consent based data processing.
`final Unit`	`setConsent(Boolean isConsent)`	Whether the purpose is used as a consent based data processing.
`final Boolean`	`isEssential()`	Whether this is an essential purpose.
`final Unit`	`setEssential(Boolean isEssential)`	Whether this is an essential purpose.
`final Boolean`	`isLegitimateInterest()`	Whether the purpose is used as a legitimate interest based data processing.
`final Unit`	`setLegitimateInterest(Boolean isLegitimateInterest)`	Whether the purpose is used as a legitimate interest based data processing.
`final Boolean`	`isSpecialFeature()`	Whether this is a special feature displayed as a purpose.
`final Unit`	`setSpecialFeature(Boolean isSpecialFeature)`	Whether this is a special feature displayed as a purpose.
`DataProcessingNamespaces`	`getNamespaces()`
`final Boolean`	`isConsentNotEssential()`	Whether the purpose is used as a consent based data processing
`final Boolean`	`isLegitimateInterestNotEssential()`	Whether the purpose is used as a legitimate interest based data processing
`final Boolean`	`isLegitimateInterestOnly()`	Whether the purpose is used as legitimate interest legal base only.

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

- Constructor Detail
  - InternalPurpose
```
InternalPurpose(String id, String iabId, String name, String description, String descriptionLegal, List<String> illustrations, Boolean isConsent, Boolean isEssential, Boolean isLegitimateInterest, Boolean isSpecialFeature, String type, DataProcessingNamespaces namespaces, Boolean iabConsentRequired, Boolean iabLiRequired, Boolean isFirstPartyConsent, Boolean isFirstPartyLi)
```
- Method Detail
  - getCategory
```
 final PurposeCategory getCategory()
```
  - setCategory
```
 final Unit setCategory(PurposeCategory category)
```
  - getId
```
 String getId()
```
    Purpose id used internally by Didomi.
  - getIabId
```
 String getIabId()
```
    Purpose id as defined by IAB.
  - getName
```
 String getName()
```
    Purpose human-readable name or translation key.
  - setName
```
 Unit setName(@SerializedName(value = "name") String name)
```
    Purpose human-readable name or translation key.
  - getDescription
```
 String getDescription()
```
    Purpose description.
  - setDescription
```
 Unit setDescription(@SerializedName(value = "description") String description)
```
    Purpose description.
  - getDescriptionLegal
```
 String getDescriptionLegal()
```
    Purpose legal description.
  - setDescriptionLegal
```
 Unit setDescriptionLegal(@SerializedName(value = "descriptionLegal") String descriptionLegal)
```
    Purpose legal description.
  - getIllustrations
```
 List<String> getIllustrations()
```
    Purpose illustrations.
  - setIllustrations
```
 Unit setIllustrations(@SerializedName(value = "illustrations") List<String> illustrations)
```
    Purpose illustrations.
  - isConsent
```
 final Boolean isConsent()
```
    Whether the purpose is used as a consent based data processing.
  - setConsent
```
 final Unit setConsent(Boolean isConsent)
```
    Whether the purpose is used as a consent based data processing.
  - isEssential
```
 final Boolean isEssential()
```
    Whether this is an essential purpose.
  - setEssential
```
 final Unit setEssential(Boolean isEssential)
```
    Whether this is an essential purpose.
  - isLegitimateInterest
```
 final Boolean isLegitimateInterest()
```
    Whether the purpose is used as a legitimate interest based data processing.
  - setLegitimateInterest
```
 final Unit setLegitimateInterest(Boolean isLegitimateInterest)
```
    Whether the purpose is used as a legitimate interest based data processing.
  - isSpecialFeature
```
 final Boolean isSpecialFeature()
```
    Whether this is a special feature displayed as a purpose.
  - setSpecialFeature
```
 final Unit setSpecialFeature(Boolean isSpecialFeature)
```
    Whether this is a special feature displayed as a purpose.
  - getNamespaces
```
 DataProcessingNamespaces getNamespaces()
```
  - isConsentNotEssential
```
 final Boolean isConsentNotEssential()
```
    Whether the purpose is used as a consent based data processing
    
    Returns:
    
    true if is not essential and at least one required vendor requires this purpose for consent based data processing
  - isLegitimateInterestNotEssential
```
 final Boolean isLegitimateInterestNotEssential()
```
    Whether the purpose is used as a legitimate interest based data processing
    
    Returns:
    
    true if is not essential and at least one required vendor requires this purpose for LI based data processing
  - isLegitimateInterestOnly
```
 final Boolean isLegitimateInterestOnly()
```
    Whether the purpose is used as legitimate interest legal base only.
    
    Returns:
    
    true if is not essential and at least one required vendor requires this purpose for LI legal base and no required vendor requires this purpose for consent legal base.

Class InternalPurpose

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InternalPurpose

Method Detail

getCategory

setCategory

getId

getIabId

getName

setName

getDescription

setDescription

getDescriptionLegal

setDescriptionLegal

getIllustrations

setIllustrations

isConsent

setConsent

isEssential

setEssential

isLegitimateInterest

setLegitimateInterest

isSpecialFeature

setSpecialFeature

getNamespaces

isConsentNotEssential

isLegitimateInterestNotEssential

isLegitimateInterestOnly