Interface IGdprManager

All Superinterfaces:

IDisposable, IEntity

public interface IGdprManager
extends IEntity

Manages the GDPR.

Method Summary

Modifier and Type	Method	Description
void	cancelContactProfileGdprRequest(int contactProfileGdprRequestId)	Cancels a contact profile GDPR request.
int	createConsent(ConsentCreateRequest request)	Creates a consent.
void	createContactProfileFieldPrivacy(String directoryName, ContactProfileFieldPrivacyCreateRequest[] requests)	Creates contact profile field privacy entries.
int	createContactProfileGdprRequest(ContactProfileGdprRequest request)	Creates a contact profile GDPR request.
int	createPrivacyCategory(PrivacyCategoryCreateRequest request)	Creates a custom privacy category.
int	createPurpose(PurposeCreateRequest request)	Creates a custom purpose.
void	deleteConsent(int consentId)	Deletes a consent.
void	deleteContactProfileFieldPrivacy(String directoryName, int[] contactProfileFieldPrivacyFieldIds)	Deletes contact profile field privacy entries.
void	deleteOutputContactProfileGdprRequest(int contactProfileGdprRequestId)	Deletes the output document of a contact profile GDPR request.
void	deletePrivacyCategory(String privacyCategoryName)	Deletes a custom privacy category.
void	deletePurpose(String purposeName)	Deletes a custom purpose.
void	executeContactProfileGdprRequest(int contactProfileGdprRequestId)	Executes a contact profile GDPR request.
ConsentData	getConsent(int consentId)	Gets information about the consent.
ConsentData	getConsent(int consentId, PurposeFilter purposeFilter)	Gets information about the consent.
ConsentAuditData	getConsentAudit(int consentAuditId)	Gets information about the consent audit.
int	getConsentAuditCount(String sql)	Gets the count of the consent audit.
IConsentAuditCursor	getConsentAuditCursor(int cursorId)	Gets a consent audit cursor open in the instance.
IConsentAuditCursor[]	getConsentAuditCursors()	Returns the consent audit cursors open in the instance.
byte[]	getConsentAuditProofDocument(int consentAuditId)	Gets the consent audit proof document.
TableSchema	getConsentAuditTableSchema()	Gets the table schema of the consent audit.
int	getConsentCount(String sql)	Gets the count of the consent.
IConsentCursor	getConsentCursor(int cursorId)	Gets a consent cursor open in the instance.
IConsentCursor[]	getConsentCursors()	Returns the consent cursors open in the instance.
byte[]	getConsentProofDocument(int consentId)	Gets the consent proof document.
TableSchema	getConsentTableSchema()	Gets the table schema of the consent.
IConsentUploader	getConsentUploaderById(int consentUploaderId)	Gets a IConsentUploader object by the identifier within the IntegrationServer.
IConsentUploader	getConsentUploaderByTaskId(int consentUploaderTaskId)	Returns a IConsentUploaderLoader object that previously has started an upload task in the Altitude uCI Server.
IConsentUploader[]	getConsentUploaders()	Gets the IConsentUploader objects.
ContactProfileFieldPrivacyData	getContactProfileFieldPrivacy(String directoryName, int contactProfileFieldPrivacyFieldId)	Gets information about the contact profile field privacy.
IContactProfileFieldPrivacyCursor	getContactProfileFieldPrivacyCursor(int cursorId)	Gets a contact profile field privacy cursor open in the instance.
IContactProfileFieldPrivacyCursor[]	getContactProfileFieldPrivacyCursors()	Returns the contact profile field privacy cursors open in the instance.
TableSchema	getContactProfileFieldPrivacyTableSchema()	Gets the table schema of the contact profile field privacy.
ContactProfileGdprRequestData	getContactProfileGdprRequest(int contactProfileGdprRequestId)	Gets information about the contact profile GDPR request.
int	getContactProfileGdprRequestCount(String sql)	Gets the count of the contact profile GDPR request.
IContactProfileGdprRequestCursor	getContactProfileGdprRequestCursor(int cursorId)	Gets a contact profile GDPR request cursor open in the instance.
IContactProfileGdprRequestCursor[]	getContactProfileGdprRequestCursors()	Returns the contact profile GDPR request cursors open in the instance.
byte[]	getContactProfileGdprRequestPortabilityOutput(int contactProfileGdprRequestId)	Gets the contact profile GDPR request portability output document.
TableSchema	getContactProfileGdprRequestTableSchema()	Gets the table schema of the contact profile GDPR request.
boolean	getGdprEnabled()	If true, the GDPR is enabled.
IInstance	getInstance()	Returns the instance.
PrivacyCategoryData	getPrivacyCategoryById(int privacyCategoryId)	Gets information about the privacy category.
PrivacyCategoryData	getPrivacyCategoryByName(String privacyCategoryName)	Gets information about the privacy category.
IPrivacyCategoryCursor	getPrivacyCategoryCursor(int cursorId)	Gets a privacy category cursor open in the instance.
IPrivacyCategoryCursor[]	getPrivacyCategoryCursors()	Returns the privacy category cursors open in the instance.
TableSchema	getPrivacyCategoryTableSchema()	Gets the table schema of the privacy category.
PurposeData	getPurposeById(int purposeId)	Gets information about the purpose.
PurposeData	getPurposeByName(String purposeName)	Gets information about the purpose.
IPurposeCursor	getPurposeCursor(int cursorId)	Gets a purpose cursor open in the instance.
IPurposeCursor[]	getPurposeCursors()	Returns the purpose cursors open in the instance.
TableSchema	getPurposeTableSchema()	Gets the table schema of the purpose.
IConsentAuditCursor	newConsentAuditCursor(String[] columns, String sql)	Opens a consent audit cursor.
IConsentCursor	newConsentCursor(String[] columns, String sql)	Opens a consent cursor.
IConsentCursor	newConsentCursor(String[] columns, String sql, PurposeFilter purposeFilter)	Opens a consent cursor.
IConsentUploader	newConsentUploader()	Creates an IConsentUploader used to upload consents.
IContactProfileFieldPrivacyCursor	newContactProfileFieldPrivacyCursor(String directoryName, String[] columns, String sql)	Opens a contact profile field privacy cursor.
IContactProfileGdprRequestCursor	newContactProfileGdprRequestCursor(String[] columns, String sql)	Opens a contact profile GDPR request cursor.
IPrivacyCategoryCursor	newPrivacyCategoryCursor(String[] columns, String sql)	Opens a privacy category cursor.
IPurposeCursor	newPurposeCursor(String[] columns, String sql)	Opens a purpose cursor.
void	reExecuteContactProfileGdprRequest(int contactProfileGdprRequestId)	Re-executes a contact profile GDPR request.
IConsentAuditCursor	tryGetConsentAuditCursor(int cursorId)	Gets a consent audit cursor open in the instance or null if it doesn't exist.
IConsentCursor	tryGetConsentCursor(int cursorId)	Gets a consent cursor open in the instance or null if it doesn't exist.
IContactProfileFieldPrivacyCursor	tryGetContactProfileFieldPrivacyCursor(int cursorId)	Gets a contact profile field privacy cursor open in the instance or null if it doesn't exist.
IContactProfileGdprRequestCursor	tryGetContactProfileGdprRequestCursor(int cursorId)	Gets a contact profile GDPR request cursor open in the instance or null if it doesn't exist.
IPrivacyCategoryCursor	tryGetPrivacyCategoryCursor(int cursorId)	Gets a privacy category cursor open in the instance or null if it doesn't exist.
IPurposeCursor	tryGetPurposeCursor(int cursorId)	Gets a purpose cursor open in the instance or null if it doesn't exist.
void	updateConsent(int consentId, ConsentUpdateRequest request)	Updates a consent.
void	updateConsentProofDocument(int consentId, byte[] proofDocument)	Updates a consent proof document.
void	updateContactProfileFieldPrivacy(String directoryName, ContactProfileFieldPrivacyUpdateRequest[] requests)	Updates contact profile field privacy entries.
void	updatePrivacyCategory(String privacyCategoryName, PrivacyCategoryUpdateRequest request)	Updates a custom privacy category.
void	updatePurpose(String purposeName, PurposeUpdateRequest request)	Updates a purpose.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

cancelContactProfileGdprRequest

void cancelContactProfileGdprRequest(int contactProfileGdprRequestId)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels a contact profile GDPR request.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createConsent

int createConsent(ConsentCreateRequest request)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a consent.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created consent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createContactProfileFieldPrivacy

void createContactProfileFieldPrivacy(String directoryName,
 ContactProfileFieldPrivacyCreateRequest[] requests)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Creates contact profile field privacy entries.

Parameters:

directoryName - Name of the directory.

requests - Contains the fields that must be overwritten

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createContactProfileGdprRequest

int createContactProfileGdprRequest(ContactProfileGdprRequest request)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a contact profile GDPR request.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createPrivacyCategory

int createPrivacyCategory(PrivacyCategoryCreateRequest request)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a custom privacy category.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created privacy category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createPurpose

int createPurpose(PurposeCreateRequest request)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a custom purpose.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created purpose.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteConsent

void deleteConsent(int consentId)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a consent.

Parameters:

consentId - Identifier of the consent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteContactProfileFieldPrivacy

void deleteContactProfileFieldPrivacy(String directoryName,
 int[] contactProfileFieldPrivacyFieldIds)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes contact profile field privacy entries.

Parameters:

directoryName - Name of the directory.

contactProfileFieldPrivacyFieldIds - Identifiers of the fields of the contact profile field privacy.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteOutputContactProfileGdprRequest

void deleteOutputContactProfileGdprRequest(int contactProfileGdprRequestId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes the output document of a contact profile GDPR request.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deletePrivacyCategory

void deletePrivacyCategory(String privacyCategoryName)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a custom privacy category.

Parameters:

privacyCategoryName - Name of the privacy category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deletePurpose

void deletePurpose(String purposeName)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a custom purpose.

Parameters:

purposeName - Name of purpose.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

executeContactProfileGdprRequest

void executeContactProfileGdprRequest(int contactProfileGdprRequestId)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Executes a contact profile GDPR request.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsent

ConsentData getConsent(int consentId)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the consent.

Parameters:

consentId - Identifier of the consent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsent

ConsentData getConsent(int consentId,
 PurposeFilter purposeFilter)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the consent.

Parameters:

consentId - Identifier of the consent.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAudit

ConsentAuditData getConsentAudit(int consentAuditId)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the consent audit.

Parameters:

consentAuditId - Identifier of the consent audit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAuditCount

int getConsentAuditCount(String sql)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the consent audit.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAuditCursor

IConsentAuditCursor getConsentAuditCursor(int cursorId)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a consent audit cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IConsentAuditCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAuditCursors

IConsentAuditCursor[] getConsentAuditCursors()
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the consent audit cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAuditProofDocument

byte[] getConsentAuditProofDocument(int consentAuditId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the consent audit proof document.

Parameters:

consentAuditId - Identifier of the consent audit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentAuditTableSchema

TableSchema getConsentAuditTableSchema()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the consent audit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentCount

int getConsentCount(String sql)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the consent.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentCursor

IConsentCursor getConsentCursor(int cursorId)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a consent cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IConsentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentCursors

IConsentCursor[] getConsentCursors()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the consent cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentProofDocument

byte[] getConsentProofDocument(int consentId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the consent proof document.

Parameters:

consentId - Identifier of the consent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentTableSchema

TableSchema getConsentTableSchema()
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the consent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentUploaderById

IConsentUploader getConsentUploaderById(int consentUploaderId)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a IConsentUploader object by the identifier within the IntegrationServer.

Parameters:

consentUploaderId - Identifier of the IConsentUploader object.

Returns:

The IConsentUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentUploaderByTaskId

IConsentUploader getConsentUploaderByTaskId(int consentUploaderTaskId)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a IConsentUploaderLoader object that previously has started an upload task in the Altitude uCI Server.

Parameters:

consentUploaderTaskId - Identifier of the entity upload task returned by the IConsentUploader.Start

Returns:

The IConsentUploader object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getConsentUploaders

IConsentUploader[] getConsentUploaders()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the IConsentUploader objects.

Returns:

The IConsentUploader objects.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldPrivacy

ContactProfileFieldPrivacyData getContactProfileFieldPrivacy(String directoryName,
 int contactProfileFieldPrivacyFieldId)
                                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the contact profile field privacy.

Parameters:

directoryName - Name of the directory.

contactProfileFieldPrivacyFieldId - Identifier of the field of the contact profile field privacy.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldPrivacyCursor

IContactProfileFieldPrivacyCursor getContactProfileFieldPrivacyCursor(int cursorId)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile field privacy cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileFieldPrivacyCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldPrivacyCursors

IContactProfileFieldPrivacyCursor[] getContactProfileFieldPrivacyCursors()
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile field privacy cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileFieldPrivacyTableSchema

TableSchema getContactProfileFieldPrivacyTableSchema()
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile field privacy.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequest

ContactProfileGdprRequestData getContactProfileGdprRequest(int contactProfileGdprRequestId)
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the contact profile GDPR request.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequestCount

int getContactProfileGdprRequestCount(String sql)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the count of the contact profile GDPR request.

Parameters:

sql - SQL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequestCursor

IContactProfileGdprRequestCursor getContactProfileGdprRequestCursor(int cursorId)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile GDPR request cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileGdprRequestCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequestCursors

IContactProfileGdprRequestCursor[] getContactProfileGdprRequestCursors()
                                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the contact profile GDPR request cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequestPortabilityOutput

byte[] getContactProfileGdprRequestPortabilityOutput(int contactProfileGdprRequestId)
                                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact profile GDPR request portability output document.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileGdprRequestTableSchema

TableSchema getContactProfileGdprRequestTableSchema()
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getGdprEnabled

boolean getGdprEnabled()
                throws Exception,
altitude.integrationServer.exceptions.ISException

If true, the GDPR is enabled.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrivacyCategoryById

PrivacyCategoryData getPrivacyCategoryById(int privacyCategoryId)
                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the privacy category.

Parameters:

privacyCategoryId - Identifier of the privacy category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrivacyCategoryByName

PrivacyCategoryData getPrivacyCategoryByName(String privacyCategoryName)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the privacy category.

Parameters:

privacyCategoryName - Name of the privacy category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrivacyCategoryCursor

IPrivacyCategoryCursor getPrivacyCategoryCursor(int cursorId)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a privacy category cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPrivacyCategoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrivacyCategoryCursors

IPrivacyCategoryCursor[] getPrivacyCategoryCursors()
                                            throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the privacy category cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrivacyCategoryTableSchema

TableSchema getPrivacyCategoryTableSchema()
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the privacy category.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPurposeById

PurposeData getPurposeById(int purposeId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the purpose.

Parameters:

purposeId - Identifier of the purpose.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPurposeByName

PurposeData getPurposeByName(String purposeName)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the purpose.

Parameters:

purposeName - Name of the purpose.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPurposeCursor

IPurposeCursor getPurposeCursor(int cursorId)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a purpose cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPurposeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPurposeCursors

IPurposeCursor[] getPurposeCursors()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the purpose cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPurposeTableSchema

TableSchema getPurposeTableSchema()
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the purpose.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newConsentAuditCursor

IConsentAuditCursor newConsentAuditCursor(String[] columns,
 String sql)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a consent audit cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IConsentAuditCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newConsentCursor

IConsentCursor newConsentCursor(String[] columns,
 String sql)
                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a consent cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IConsentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newConsentCursor

IConsentCursor newConsentCursor(String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a consent cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The IConsentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newConsentUploader

IConsentUploader newConsentUploader()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Creates an IConsentUploader used to upload consents. The IConsentUploader object is returned by IInstanceManager.GetConsentUploader method.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newContactProfileFieldPrivacyCursor

IContactProfileFieldPrivacyCursor newContactProfileFieldPrivacyCursor(String directoryName,
 String[] columns,
 String sql)
                                                               throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile field privacy cursor.

Parameters:

directoryName - Name of the directory.

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileFieldPrivacyCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newContactProfileGdprRequestCursor

IContactProfileGdprRequestCursor newContactProfileGdprRequestCursor(String[] columns,
 String sql)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a contact profile GDPR request cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IContactProfileGdprRequestCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPrivacyCategoryCursor

IPrivacyCategoryCursor newPrivacyCategoryCursor(String[] columns,
 String sql)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a privacy category cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IPrivacyCategoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newPurposeCursor

IPurposeCursor newPurposeCursor(String[] columns,
 String sql)
                         throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a purpose cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IPurposeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

reExecuteContactProfileGdprRequest

void reExecuteContactProfileGdprRequest(int contactProfileGdprRequestId)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Re-executes a contact profile GDPR request.

Parameters:

contactProfileGdprRequestId - Identifier of the contact profile GDPR request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetConsentAuditCursor

IConsentAuditCursor tryGetConsentAuditCursor(int cursorId)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a consent audit cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IConsentAuditCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetConsentCursor

IConsentCursor tryGetConsentCursor(int cursorId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a consent cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IConsentCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileFieldPrivacyCursor

IContactProfileFieldPrivacyCursor tryGetContactProfileFieldPrivacyCursor(int cursorId)
                                                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile field privacy cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileFieldPrivacyCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetContactProfileGdprRequestCursor

IContactProfileGdprRequestCursor tryGetContactProfileGdprRequestCursor(int cursorId)
                                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact profile GDPR request cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IContactProfileGdprRequestCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetPrivacyCategoryCursor

IPrivacyCategoryCursor tryGetPrivacyCategoryCursor(int cursorId)
                                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a privacy category cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPrivacyCategoryCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetPurposeCursor

IPurposeCursor tryGetPurposeCursor(int cursorId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a purpose cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IPurposeCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateConsent

void updateConsent(int consentId,
 ConsentUpdateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a consent.

Parameters:

consentId - Identifier of the consent.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateConsentProofDocument

void updateConsentProofDocument(int consentId,
 byte[] proofDocument)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a consent proof document.

Parameters:

consentId - Identifier of the consent.

proofDocument - Consent proof document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateContactProfileFieldPrivacy

void updateContactProfileFieldPrivacy(String directoryName,
 ContactProfileFieldPrivacyUpdateRequest[] requests)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Updates contact profile field privacy entries.

Parameters:

directoryName - Name of the directory.

requests - Contains the fields that must be overwritten

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updatePrivacyCategory

void updatePrivacyCategory(String privacyCategoryName,
 PrivacyCategoryUpdateRequest request)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a custom privacy category.

Parameters:

privacyCategoryName - Name of the privacy category.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updatePurpose

void updatePurpose(String purposeName,
 PurposeUpdateRequest request)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a purpose.

Parameters:

purposeName - Name of the purpose.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException