Class NSConsentPurpose

Carrier object for ConsentPurpose.

Constructors

NSConsentPurpose()

Initializes a new instance of the NSConsentPurpose class.

Declaration

NSConsentPurpose

Methods

GetActive()

Declaration

Integer GetActive()

Examples

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

Returns

Type	Description
Integer	Is the consent purpose active or not.

GetConsentPurposeId()

Declaration

Integer GetConsentPurposeId()

Examples

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

Returns

Type	Description
Integer	Primary key.

GetConsentText()

Declaration

String GetConsentText()

Examples

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

Returns

Type	Description
String	Form text used for the actual checkbox.

GetDeleted()

Declaration

Bool GetDeleted()

Examples

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

Returns

Type	Description
Bool	true if the NSConsentPurpose is deleted.

GetFormText()

Declaration

String GetFormText()

Examples

NSConsentPurpose thing;
String formText = thing.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.

GetKey()

Declaration

String GetKey()

Examples

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

Returns

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

GetName()

Declaration

String GetName()

Examples

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

Returns

Type	Description
String	Name of consent purpose.

GetPrivacyStatementDesc()

Declaration

String GetPrivacyStatementDesc()

Examples

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

Returns

Type	Description
String	Name or description for the privacy statement.

GetPrivacyStatementUrl()

Declaration

String GetPrivacyStatementUrl()

Examples

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

Returns

Type	Description
String	URL referencing the actual privacy statement.

GetRank()

Declaration

Integer GetRank()

Examples

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

Returns

Type	Description
Integer	Rank of this consent source.

GetTooltip()

Declaration

String GetTooltip()

Examples

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

Returns

Type	Description
String	List item tooltip.

GetUpdatedBy()

Declaration

NSAssociate GetUpdatedBy()

Examples

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

Returns

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

GetUpdatedDate()

Declaration

DateTime GetUpdatedDate()

Examples

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

Returns

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

SetActive(Integer)

Declaration

Void SetActive(Integer active)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetConsentPurposeId(Integer)

Declaration

Void SetConsentPurposeId(Integer consentPurposeId)

Examples

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

Parameters

Type	Name	Description
Integer	consentPurposeId	Primary key.

Returns

Type	Description
Void

SetConsentText(String)

Declaration

Void SetConsentText(String consentText)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetDeleted(Bool)

Declaration

Void SetDeleted(Bool deleted)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetFormText(String)

Declaration

Void SetFormText(String formText)

Examples

NSConsentPurpose thing;
String formText;
thing.SetFormText(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

SetKey(String)

Declaration

Void SetKey(String key)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type	Name	Description
String	name	Name of consent purpose.

Returns

Type	Description
Void

SetPrivacyStatementDesc(String)

Declaration

Void SetPrivacyStatementDesc(String privacyStatementDesc)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetPrivacyStatementUrl(String)

Declaration

Void SetPrivacyStatementUrl(String privacyStatementUrl)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Examples

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

Parameters

Type	Name	Description
Integer	rank	Rank of this consent source.

Returns

Type	Description
Void

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Examples

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

Parameters

Type	Name	Description
String	tooltip	List item tooltip.

Returns

Type	Description
Void

SetUpdatedBy(NSAssociate)

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetUpdatedDate(DateTime)

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Examples

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

Parameters

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

Returns

Type	Description
Void