Utility class for Apex Sharing

-

Ever faced a situation where you need to share records and it cannot be achieved through standard sharing rules? In such cases, Apex Managed Sharing comes to your rescue. Let us first try to understand what sharing means.

In an org where the OWD is restricitive (OWD is set other than public read/ write or public read only), you may have some requirements where you need to share records with some users. Sharing is the act of granting a user or group of users permission to perform a set of actions on a record or set of records. Sharing access can be granted using the Salesforce user interface and Force.com, or programmatically using Apex.

 To access sharing programmatically, you must use the share object associated with the standard or custom object for which you want to share. For example, AccountShare is the sharing object for the Account object, ContactShare is the sharing object for the Contact object, and so on. In addition, all custom object sharing objects are named as follows, where MyCustomObject is the name of the custom object:
MyCustomObject__Share

It is very common to implement Apex sharing due to the complexity of requirements which need to be implemented. Instead of writing the same code in different ways across projects, I thought of writing a utility class which can be used across projects to create share records. 

Utility Class : 

 /** Author : Ravi Dutt Sharma

*  Created Date : 6/10/2016
*  Description : Utility class for Apex managed sharing
**/
public class ApexSharingUtils {
    
    /** Method name : createLeadShare
     * Arguments : Id leadId - Record id of the lead record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the leads record needs to be shared
     * String leadAccessLevel - Record sharing access level - Read, Edit, All
     * Return type : LeadShare
     * Description : Creates lead share record as per the parameters passed to the method
    **/
    public static LeadShare createLeadShare(Id leadId, Id userOrGroupId, 
                                                  String leadAccessLevel){
        LeadShare share = new LeadShare();
        share.LeadId = leadId;
        share.UserOrGroupId = userOrGroupId;                                              
        share.LeadAccessLevel = leadAccessLevel;
        return share;
    }
    
    /** Method name : createAccountShare
     * Arguments : Id accountId - Record id of the account record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the account record needs to be shared
     * String accountAccessLevel - Record sharing access level - Read, Edit, All
     * String opportunityAccessLevel - Record sharing access level of child opportunities present under the account- Read, Edit, All
     * String caseAccessLevel - Record sharing access level of child cases present under the account- Read, Edit, All
     * Return type : AccountShare
     * Description : Creates account share record as per the parameters passed to the method
    **/
    public static AccountShare createAccountShare(Id accountId, ID userOrGroupId, 
                                                  String accountAccessLevel,String opportunityAccessLevel, String caseAccessLevel){
        AccountShare share = new AccountShare();
        share.AccountId = accountId;
        share.UserOrGroupId = userOrGroupId;
        share.AccountAccessLevel = accountAccessLevel;
        share.OpportunityAccessLevel = opportunityAccessLevel;
        share.CaseAccessLevel = caseAccessLevel;                                       
        return share;
    }
    
     /** Method name : createContactShare
     * Arguments : Id contactId - Record id of the contact record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the contact record needs to be shared
     * String contactAccessLevel - Record sharing access level - Read, Edit, All
     * Return type : ContactShare
     * Description : Creates contact share record as per the parameters passed to the method
    **/
    public static ContactShare createContactShare(Id contactId, Id userOrGroupId, 
                                                  String contactAccessLevel){
        ContactShare share = new ContactShare();
        share.ContactId = contactId;
        share.UserOrGroupId = userOrGroupId;                                              
        share.ContactAccessLevel = contactAccessLevel;
        return share;
    }
    
    /** Method name : createOpportunityShare
     * Arguments : Id opportunityId - Record id of the opportunity record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the opportunity record needs to be shared
     * String opportunityAccessLevel - Record sharing access level - Read, Edit, All
     * Return type : OpportunityShare
     * Description : Creates opportunity share record as per the parameters passed to the method
    **/
    public static OpportunityShare createOpportunityShare(Id opportunityId, Id userOrGroupId, 
                                                  String opportunityAccessLevel){
        OpportunityShare share = new OpportunityShare();
        share.OpportunityId = opportunityId;
        share.UserOrGroupId = userOrGroupId;                                              
        share.OpportunityAccessLevel = opportunityAccessLevel;
        return share;
    }
    
    /** Method name : createCaseShare
     * Arguments : Id caseId - Record id of the case record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the case record needs to be shared
     * String caseAccessLevel - Record sharing access level - Read, Edit, All
     * Return type : CaseShare
     * Description : Creates case share record as per the parameters passed to the method
    **/
    public static CaseShare createCaseShare(Id caseId, Id userOrGroupId, 
                                                  String caseAccessLevel){
        CaseShare share = new CaseShare();
        share.CaseId = caseId;
        share.UserOrGroupId = userOrGroupId;                                              
        share.CaseAccessLevel = caseAccessLevel;
        return share;
    }
    
    /** Method name : createCustomObjectShare
     * Arguments : Id recordId - Record id of the custom object record which needs to be shared
     * Id userOrGroupId - Record id of user or public group with which the custom object record needs to be shared
     * String recordAccessLevel - Record sharing access level - Read, Edit, All
     * Return type : sObject - share object specific to the custom object
     * Description : Creates custom object share record as per the parameters passed to the method
    **/
    public static sObject createCustomObjectShare(Id recordId, Id userOrGroupId,
                                                  String recordAccessLevel){
        String sObjLabel = recordId.getSObjectType().getDescribe().getLabel();
        sObject sObj = Schema.getGlobalDescribe().get(sObjLabel + '__Share').newSObject();
        sObj.put('ParentId',recordId);
        sObj.put('UserOrGroupId',userOrGroupId);
        sObj.put('AccessLevel',recordAccessLevel);
        return sObj;
    }

}

Comments

Post a Comment

Popular posts from this blog

Salesforce Lightning: Countdown timer

-
Image
Today we will have a look at how to create a lightning component for countdown timer which can be used on pages where an operation needs to be completed within a specific time period. Example, an online exam or a banking transaction which expires after a specific time period. The component contains a datetime field which represents the end time. Once the user selects the date and time and clicks on Start Timer button, the countdown timer will start. Below is the lightning component: CountdownTimer.cmp <aura:component implements="force:appHostable,flexipage:availableForAllPageTypes,flexipage:availableForRecordHome,force:hasRecordId" access="global" >       <aura:attribute name="endTime" type="String"/>       <aura:attribute name="timeLeft" type="String"/>       <lightning:tile label="Time Left" class="slds-page-header">         {!v.timeLeft}     </lightning:tile...
Read more

Salesforce Hacks: System.LimitException: Too many queueable jobs added to the queue: 2

-
Queueable classes are great to use and provides a wide range of advantages when compared to future methods. But there are some undocumented limitations which you will come across if you are using Queueable classes extensively inside your batch classes. Lets take an example of badly written trigger on Account.  trigger AccountTrigger on Account (before insert) {     for(Account acc: Trigger.new){         Database.executeBatch(new CreateContactBatch(), 2);     } }   The above trigger calls a batch class for every account record that gets inserted in database. So if you insert N accounts in a single transaction via dataloader or anonymous block or through any other means, the trigger will execute the batch class N number of times. Below is the code for batch class: global class CreateContactBatch implements Database.Batchable<sObject> {          global Database.QueryLocator start(Database.Bat...
Read more

Building an Org Role Hierarchy component in LWC

-
Image
You might have observed that the role hierarchy which gets displayed in the org (Setup > Users > Roles) is still displayed using a VF component. Today, we will see how to create the same role hierarchy using LWC and Apex. LWC provides us with a component called lightning-tree which displays a nested tree. We will make use of this component to display the role hierarchy in a tree structure. In Apex, we will query all the user roles and form a JSON structure which will be fed to the lightning-tree component. Let's first see the LWC component - roleHierarchy: roleHierarchy.html <template> <div class="slds-p-around_medium lgc-bg"> <lightning-tree items={roles} header="Roles"> </lightning-tree> </div> </template> Here we have used the lightning-tree component which will display the data in a tree structure. The items attribute is of type Object which has nested i...
Read more