Changes between Version 19 and Version 20 of S3/ConsentTracking

Timestamp:

06/13/19 08:32:51 (6 years ago)

Author:

Dominic König

Comment:

--

S3/ConsentTracking

@@ -95 +95 @@
 === consent_query ===
 
-''[tbd]''
+The {{{auth_Consent.consent_query}}} method can be used to filter a DAL table for records belonging to persons that have consented to a particular processing type:
+
+{{{#!python
+# Get HR records where the person has consented to the HRDSHARE processing type:
+table = s3db.hrm_human_resource
+query = s3db.auth_Consent.consent_query(table, "HRDSHARE", field="person_id") & (table.deleted==False)
+rows = db(query).select(...)
+}}}
+
+If {{{field}}} is not specified, {{{person_id}}} will be assumed (or {{{id}}} when the table is pr_person).
+
+{{{consent_query}}} is a class method, so instantiation of {{{auth_Consent}}} is not required.
+
+The consent sub-query will include an implicit inner join with the {{{auth_consent}}} table (not aliased), which may need to be taken into account when the overall query constructs additional joins.
+
+{{{consent_query}}} takes into account whether the consent record or the consent option have expired, but it will not verify the integrity of any consent records.
 === consent_filter ===