io.didomi.sdk

Class Purpose

java.lang.Object

io.didomi.sdk.models.DataProcessing

io.didomi.sdk.Purpose

public class Purpose
extends DataProcessing

Model class for purposes

Constructor Summary

Constructors

Constructor and Description
Purpose(java.lang.String id, java.lang.String iabId, java.lang.String name, java.lang.String description)
Purpose(java.lang.String id, java.lang.String iabId, java.lang.String name, java.lang.String description, boolean custom)
Purpose(java.lang.String id, java.lang.String iabId, java.lang.String name, java.lang.String description, java.lang.String descriptionLegal)
Purpose(java.lang.String id, java.lang.String iabId, java.lang.String name, java.lang.String description, java.lang.String descriptionLegal, boolean custom)
Purpose(java.lang.String id, java.lang.String iabId, java.lang.String name, java.lang.String description, java.lang.String descriptionLegal, boolean custom, boolean isSpecialFeature)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
PurposeCategory	getCategory() Getter method for category.
java.lang.String	getDescription() Purpose description
java.lang.String	getDescriptionLegal()
java.lang.String	getIabId() Purpose IAB id
java.lang.String	getId() Purpose id
static java.util.Set<java.lang.String>	getIds(java.util.Collection<Purpose> purposes) Get IDs from a list of purposes
java.lang.String	getName() Purpose name
java.lang.String	getTranslationKeyForName()
java.lang.String	getTranslationKeyPrefix()
int	hashCode()
boolean	isConsent() Whether the purpose is used as a consent based data processing
boolean	isCustom() Deprecated.
boolean	isEssential() Whether this is an essential purpose
boolean	isLegitimateInterest() Whether the purpose is used as a legitimate interest based data processing
boolean	isSpecialFeature() Whether this is a special feature displayed as a purpose
void	setCategory(PurposeCategory category) Update purpose category.
void	setConsent(boolean consent)
void	setDescription(java.lang.String description) Update purpose description
void	setEssential(boolean essential)
void	setId(java.lang.String id)
void	setLegitimateInterest(boolean legitimateInterest)
void	setName(java.lang.String name) Update purpose name

Methods inherited from class io.didomi.sdk.models.DataProcessing

getTranslationKeyForDescription, getTranslationKeyForDescriptionLegal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Purpose

public Purpose(java.lang.String id,
               java.lang.String iabId,
               java.lang.String name,
               java.lang.String description)

Purpose

public Purpose(java.lang.String id,
               java.lang.String iabId,
               java.lang.String name,
               java.lang.String description,
               java.lang.String descriptionLegal)

Purpose

public Purpose(java.lang.String id,
               java.lang.String iabId,
               java.lang.String name,
               java.lang.String description,
               boolean custom)

Purpose

public Purpose(java.lang.String id,
               java.lang.String iabId,
               java.lang.String name,
               java.lang.String description,
               java.lang.String descriptionLegal,
               boolean custom)

Purpose

public Purpose(java.lang.String id,
               @Nullable
               java.lang.String iabId,
               java.lang.String name,
               java.lang.String description,
               java.lang.String descriptionLegal,
               boolean custom,
               boolean isSpecialFeature)

Method Detail

getTranslationKeyPrefix

public java.lang.String getTranslationKeyPrefix()

Specified by:

getTranslationKeyPrefix in class DataProcessing

getTranslationKeyForName

public java.lang.String getTranslationKeyForName()

Overrides:

getTranslationKeyForName in class DataProcessing

getId

public java.lang.String getId()

Purpose id

Specified by:

getId in class DataProcessing

Returns:

id of the purpose used internally by Didomi

setId

public void setId(java.lang.String id)

getIabId

@Nullable
public java.lang.String getIabId()

Purpose IAB id

Specified by:

getIabId in class DataProcessing

Returns:

id of the purpose as defined by IAB

getName

public java.lang.String getName()

Purpose name

Specified by:

getName in class DataProcessing

Returns:

a human-readable purpose name or translation key

getDescription

public java.lang.String getDescription()

Purpose description

Specified by:

getDescription in class DataProcessing

Returns:

description of the purpose

getDescriptionLegal

public java.lang.String getDescriptionLegal()

Specified by:

getDescriptionLegal in class DataProcessing

isCustom

@Deprecated
public boolean isCustom()

Deprecated.

isEssential

public boolean isEssential()

Whether this is an essential purpose

Returns:

true if the purpose is essential

isSpecialFeature

public boolean isSpecialFeature()

Whether this is a special feature displayed as a purpose

Returns:

true if this is a special feature

setEssential

public void setEssential(boolean essential)

isLegitimateInterest

public boolean isLegitimateInterest()

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 legitimate interest based data processing

setLegitimateInterest

public void setLegitimateInterest(boolean legitimateInterest)

isConsent

public boolean isConsent()

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

setConsent

public void setConsent(boolean consent)

getCategory

public PurposeCategory getCategory()

Getter method for category.

Returns:

the purpose category

setCategory

public void setCategory(PurposeCategory category)

Update purpose category.

Parameters:

category - new category

setName

public void setName(java.lang.String name)

Update purpose name

Parameters:

name - new name

setDescription

public void setDescription(java.lang.String description)

Update purpose description

Parameters:

description - new description

getIds

public static java.util.Set<java.lang.String> getIds(java.util.Collection<Purpose> purposes)

Get IDs from a list of purposes

Parameters:

purposes -

Returns:

the list of ids of the specified purposes

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object