com.sap.cds.repackaged.audit.api.v2.AuditedObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cds-feature-auditlog-v2 Show documentation

Handler to send auditlog messages to AuditLog Service V2

There is a newer version: 3.2.0

Show newest version

package com.sap.cds.repackaged.audit.api.v2;

/**
 * The data object is the object where the personal data whose access/modification is being audited is contained.
 * The object logged should look similar to:
 *  * {
 *    "type": "testType",
 *    "id": {
 *      "key1": "value1",
 *      "key2": "value2"
 *    }
 * }, providing more detailed information on the type of the object where the changed configuration is located and
 * information on the key identifiers that identify the object.
 **/
public interface AuditedObject {
	
	/**
	 * Adds type to the data object.
	 * 
	 * @param type Type of the data object.
	 */
	public void setType(String type);
	
	/**
	 * Adds identifier to the data object.
	 * 
	 * @param key The key of the identifier.
	 * @param value The value of the identifier.
	 */
	public void addIdentifier(String key, String value);

}