CanTheUser

---

layout: default

CanTheUser class

A reusable, intuitive library for determining wether or not the current use can create, read, edit, or delete objects as well as determining if the user has access or update permissions on specific fields. This class name was chosen to facilitate easy-to-understand and read code. Whenever you need to check FLS or CRUD access your code reads like this if(CanTheUser.read(new account())){} making the calling and use of this code easy and intuitive.

---

Enums

CrudType

FLSType

---

Properties

accessibleFieldsByObject → Set<String>>

updatableFieldsByObject → Set<String>>

---

Methods

bulkFLSAccessible(String obj,Set<String> fields) → Map<String, Boolean>

bulk form of flsAccessible

Parameters

Param	Description
obj	Obj name on which to check
fields	Set of Fields to check for accessibility.

Return

Type

Map<String, Boolean>

Description

Map<String, Boolean>

Example

String[] fields = new String[]{'Name', 'ShippingStreet'};
System.debug(CanTheUser.bulkFLSAccessible('Account', fields));

bulkFLSUpdatable(String obj,Set<String> fields) → Map<String, Boolean>

bulk form of flsUpdatable call

Parameters

Param	Description
obj	Name of the object
fields	Set of Field names to check

Return

Type

Map<String, Boolean>

Description

Map<String, Boolean>

Example

String[] fields = new String[]{'Name', 'ShippingStreet'};
System.debug(CanTheUser.bulkFLSUpdatable('Account', fields));

create(SObject obj) → Boolean

convenience api for determining if the running user can create the specified object

Parameters

Param	Description
obj	Object type to check create permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.create(new Account()));

create(List<SObject> objs) → Boolean

convenience api for determining if the running user can create the specified object

Parameters

Param	Description
objs	list of objects. Only the first will be checked. (logically, a list is of uniform type

Return

Type

Boolean

Description

Boolean

create(String objName) → Boolean

convenience api for determining if the running user can create the specified object

Parameters

Param	Description
String	Object type to check create permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.create('Account'));

crud(SObject obj, CrudType permission) → Boolean

Parameters

Param	Description
obj	the object type to check
permission	create, read, update or delete

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.crud(new Account(), CanTheUser.CrudType.READ));

crud(List<SObject> objs, CrudType permission) → Boolean

crud(String objectName, CrudType permission) → Boolean

destroy(SObject obj) → Boolean

convenience api for determining if the running user can delete/destroy the specified object

Parameters

Param	Description
obj	object type to check destroy permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.destroy(new Account()));

destroy(List<SObject> objs) → Boolean

convenience api for determining if the running user can delete the specified object

Parameters

Param	Description
String	Object type to check delete permissions on

Return

Type

Boolean

Description

Boolean

destroy(String objName) → Boolean

convenience api for determining if the running user can delete the specified object

Parameters

Param	Description
String	Object type to check create permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.destroy('Account'));

edit(SObject obj) → Boolean

convenience api for determining if the running user can edit / update the specified object

Parameters

Param	Description
obj	object type to check edit permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.edit(new Account()));

edit(List<SObject> objs) → Boolean

convenience api for determining if the running user can edit / update the specified objects

Parameters

Param	Description
obj	object type to check edit permissions on

Return

Type

Boolean

Description

Boolean

edit(String objName) → Boolean

convenience api for determining if the running user can edit the specified object

Parameters

Param	Description
String	Object type to check edit permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.edit('Account'));

flsAccessible(String obj, String field) → Boolean

public method to determine if a given field on a given object is Accessible (readable)

Parameters

Param	Description
obj	the object in question, in string form
field	the field in question in SObjectField form

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.flsAccessible('Account', 'Name'));

flsUpdatable(String obj, String field) → Boolean

public method to determine if a given field on a given object is Updatable.

Parameters

Param	Description
obj	the string version of an object name
field	the field to check

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.flsUpdatable('Account', 'Name'));

getFLSForFieldOnObject(String obj,String field,FLSType checkType) → Boolean

Abstracted method for retrieving or calculating (memoization) of the FLS for a given field on a given object.

Parameters

Param	Description
obj	String version of object name to check
field	String version of the field to check
checkType	Enum of Accessible or Updatable.

Return

Type

Boolean

Description

Boolean

memoizeFLSMDC(String objType, FLSType action) → Set<String>

Utilizes the Metadata catalog to determine FLS Note: this method contains a false-positive PMD violation. Normally, we'd want to check for FLS/CRUD here, but for metadata catalog objects that admins cannot remove permissions to we're ok. Additionally, even the minimum access profile user has read access to the FieldPermissions object.

Parameters

Param	Description
objType	String version of the object type to check
action	Enum of the FLS action to check permissions for

Return

Type

Set<String>

Description

set<String>

read(SObject obj) → Boolean

convenience api for determining if the running user can read / access the specified object

Parameters

Param	Description
obj	object type to check read permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.read(new Account()));

read(List<SObject> objs) → Boolean

convenience api for determining if the running user can read / access the specified objects

Parameters

Param	Description
obj	object type to check read permissions on

Return

Type

Boolean

Description

Boolean

read(String objName) → Boolean

convenience api for determining if the running user can read the specified object

Parameters

Param	Description
String	Object type to check read permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.read('Account'));

ups(SObject obj) → Boolean

convenience api for determining if the running user can upsert (insert and update) the specified objects

Parameters

Param	Description
obj	object type to check edit permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.ups(new Account()));

ups(List<SObject> objs) → Boolean

convenience api for determining if the running user can edit / update the specified objects

Parameters

Param	Description
obj	object type to check upsert permissions on

Return

Type

Boolean

Description

Boolean

ups(String objName) → Boolean

convenience api for determining if the running user can upsert the specified object

Parameters

Param	Description
String	Object type to check upsert permissions on

Return

Type

Boolean

Description

Boolean

Example

System.debug(CanTheUser.ups('Account'));

---

Inner Classes

CanTheUser.CanTheUserException class

Internal custom exception class

---

CanTheUser.PermissionCache class

this cachebuilder interface allows the CanTheUser class to cache per-object results for each object requested. This prevents the need to repeatedly calculate permission usage by calling Schema.Describe* calls

---

Methods

calculateFLS(string objType) → Map<FLSType, Boolean>>

Calculates the FLS for a given object type

Parameters

Param	Description
objType	String name of the object type

Return

Type

Map<FLSType, Boolean>>

Description

Map<String, Map<FLSType, Boolean>>

doLoad(String objType) → Object

Required method for the CacheBuilder interface. Used here to either calculate an objects per-user FLS, OR to return it from Cache. The return datastructure for this is Map<String, Map<FLSType,Boolean>> and represents: FieldName -> FLStype -> True/False

Parameters

Param	Description
objType	String object name used as the cache key

Return

Type

Object

Description

Object

---