Interface CustomModelPermissionPolicy
- All Known Implementing Classes:
BaseCustomModelPermissionPolicy
public interface CustomModelPermissionPolicy
Implement this interface to enforce custom model permissions on top of framework read/write permissions.
-
Method Summary
Modifier and Type Method Description void
applyCustomWritePermissions(ActionPermissionRequest actionPermissionRequest)
Apply further restrictions on top of existing write permissions.PermissionQueryContribution
getReportPermissionQueryContribution(ReportPermissionRequest reportPermissionRequest)
Contribution to Report Read Permissions.PermissionQueryContribution
getViewPermissionQueryContribution(ViewPermissionRequest viewPermissionRequest)
Contribution to Read Permissions for Views.
-
Method Details
-
getViewPermissionQueryContribution
PermissionQueryContribution getViewPermissionQueryContribution(ViewPermissionRequest viewPermissionRequest)Contribution to Read Permissions for Views. SeePermissionQueryContribution
. This class has a 'Where Contribution'. These two will be appended to the 'From' and 'Where' clauses of the Permissions Query SQL generated by the Platform Model Read Framework.- Parameters:
viewPermissionRequest
-ViewPermissionRequest
- Returns:
- PermissionQueryContribution containing from/where injections
-
getReportPermissionQueryContribution
PermissionQueryContribution getReportPermissionQueryContribution(ReportPermissionRequest reportPermissionRequest)Contribution to Report Read Permissions. SeePermissionQueryContribution
. This class has a 'Where Contribution'. This will be available through the ${ customModelPermissionsWhere:customModelName} macro to report authors. (This macro must be used explicitly by the report author.)- Parameters:
reportPermissionRequest
-ReportPermissionRequest
- Returns:
- PermissionQueryContribution used to derive from/where injections
-
applyCustomWritePermissions
Apply further restrictions on top of existing write permissions. To implement, iterate through the list of models and set errors on the models that do not meet the write permissions criteria.- Parameters:
actionPermissionRequest
-ActionPermissionRequest
-