Class NSConsentPurpose

Carrier object for ConsentPurpose.

Syntax

Constructors

NSConsentPurpose()

Initializes a new instance of the NSConsentPurpose class.

Declaration

NSConsentPurpose

Methods

GetActive()

Carrier object for ConsentPurpose.

Declaration

Integer GetActive()

Returns

Type	Description
Integer	Is the consent purpose active or not.

Examples

NSConsentPurpose thing;
Integer active = thing.GetActive();

GetConsentPurposeId()

Carrier object for ConsentPurpose.

Declaration

Integer GetConsentPurposeId()

Returns

Type	Description
Integer	Primary key.

Examples

NSConsentPurpose thing;
Integer consentPurposeId = thing.GetConsentPurposeId();

GetConsentText()

Carrier object for ConsentPurpose.

Declaration

String GetConsentText()

Returns

Type	Description
String	Form text used for the actual checkbox.

Examples

NSConsentPurpose thing;
String consentText = thing.GetConsentText();

GetDeleted()

Carrier object for ConsentPurpose.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	true if the NSConsentPurpose is deleted.

Examples

NSConsentPurpose thing;
Bool deleted = thing.GetDeleted();

GetFormText()

Carrier object for ConsentPurpose.

Declaration

String GetFormText()

Returns

Type	Description
String	Text for the consent form, the long text to be shown when asking the end-user for this kind of consent.

Examples

NSConsentPurpose thing;
String formText = thing.GetFormText();

GetKey()

Carrier object for ConsentPurpose.

Declaration

String GetKey()

Returns

Type	Description
String	The key used to refer to this purpose, like Process, Emarketing etc.

Examples

NSConsentPurpose thing;
String key = thing.GetKey();

GetName()

Carrier object for ConsentPurpose.

Declaration

String GetName()

Returns

Type	Description
String	Name of consent purpose.

Examples

NSConsentPurpose thing;
String name = thing.GetName();

GetPrivacyStatementDesc()

Carrier object for ConsentPurpose.

Declaration

String GetPrivacyStatementDesc()

Returns

Type	Description
String	Name or description for the privacy statement.

Examples

NSConsentPurpose thing;
String privacyStatementDesc = thing.GetPrivacyStatementDesc();

GetPrivacyStatementUrl()

Carrier object for ConsentPurpose.

Declaration

String GetPrivacyStatementUrl()

Returns

Type	Description
String	URL referencing the actual privacy statement.

Examples

NSConsentPurpose thing;
String privacyStatementUrl = thing.GetPrivacyStatementUrl();

GetRank()

Carrier object for ConsentPurpose.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank of this consent source.

Examples

NSConsentPurpose thing;
Integer rank = thing.GetRank();

GetTooltip()

Carrier object for ConsentPurpose.

Declaration

String GetTooltip()

Returns

Type	Description
String	List item tooltip.

Examples

NSConsentPurpose thing;
String tooltip = thing.GetTooltip();

GetUpdatedBy()

Carrier object for ConsentPurpose.

Declaration

NSAssociate GetUpdatedBy()

Returns

Type	Description
NSAssociate	The associate that last updated the consent purpose.

Examples

NSConsentPurpose thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

Carrier object for ConsentPurpose.

Declaration

DateTime GetUpdatedDate()

Returns

Type	Description
DateTime	The date the consent purpose was last updated.

Examples

NSConsentPurpose thing;
DateTime updatedDate = thing.GetUpdatedDate();

SetActive(Integer)

Carrier object for ConsentPurpose.

Declaration

Void SetActive(Integer active)

Parameters

Type	Name	Description
Integer	active	Is the consent purpose active or not.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
Integer active;
thing.SetActive(active);

SetConsentPurposeId(Integer)

Carrier object for ConsentPurpose.

Declaration

Void SetConsentPurposeId(Integer consentPurposeId)

Parameters

Type	Name	Description
Integer	consentPurposeId	Primary key.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
Integer consentPurposeId;
thing.SetConsentPurposeId(consentPurposeId);

SetConsentText(String)

Carrier object for ConsentPurpose.

Declaration

Void SetConsentText(String consentText)

Parameters

Type	Name	Description
String	consentText	Form text used for the actual checkbox.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String consentText;
thing.SetConsentText(consentText);

SetDeleted(Bool)

Carrier object for ConsentPurpose.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	true if the NSConsentPurpose is deleted.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
Bool deleted;
thing.SetDeleted(deleted);

SetFormText(String)

Carrier object for ConsentPurpose.

Declaration

Void SetFormText(String formText)

Parameters

Type	Name	Description
String	formText	Text for the consent form, the long text to be shown when asking the end-user for this kind of consent.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String formText;
thing.SetFormText(formText);

SetKey(String)

Carrier object for ConsentPurpose.

Declaration

Void SetKey(String key)

Parameters

Type	Name	Description
String	key	The key used to refer to this purpose, like Process, Emarketing etc.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String key;
thing.SetKey(key);

SetName(String)

Carrier object for ConsentPurpose.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Name of consent purpose.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String name;
thing.SetName(name);

SetPrivacyStatementDesc(String)

Carrier object for ConsentPurpose.

Declaration

Void SetPrivacyStatementDesc(String privacyStatementDesc)

Parameters

Type	Name	Description
String	privacyStatementDesc	Name or description for the privacy statement.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String privacyStatementDesc;
thing.SetPrivacyStatementDesc(privacyStatementDesc);

SetPrivacyStatementUrl(String)

Carrier object for ConsentPurpose.

Declaration

Void SetPrivacyStatementUrl(String privacyStatementUrl)

Parameters

Type	Name	Description
String	privacyStatementUrl	URL referencing the actual privacy statement.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String privacyStatementUrl;
thing.SetPrivacyStatementUrl(privacyStatementUrl);

SetRank(Integer)

Carrier object for ConsentPurpose.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank of this consent source.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

Carrier object for ConsentPurpose.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	List item tooltip.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUpdatedBy(NSAssociate)

Carrier object for ConsentPurpose.

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Parameters

Type	Name	Description
NSAssociate	updatedBy	The associate that last updated the consent purpose.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

Carrier object for ConsentPurpose.

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Parameters

Type	Name	Description
DateTime	updatedDate	The date the consent purpose was last updated.

Returns

Type	Description
Void

Examples

NSConsentPurpose thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);