Quick Start Guide

This article will show you how to get started using custom form logic. Other articles on this topic:

Implement the Customizer interface

First, we will create a class that can be executed by Booker25 to apply your customizations to the reservation form.

  1. Create a new Apex class and take note of the name. In our example, we will name it MyFormLogic.

  2. Make sure the class is global so Booker25 can access it.

  3. Have the class implement the B25.Form.Customizer interface. This means you will have to add the ‘customize’ method defined on the interface.
    To see the interface definition and method signature, go to Setup > Apex Classes and find the Form class, and the Customizer interface within it.

  4. Your class should now look like this:

    1 2 3 4 5 6 global with sharing class MyFormLogic implements B25.Form.Customizer { global void customize(B25.Form form) { // this is where we will add our handlers to the form } }

Configure Booker25 to use your implementation

Next, we will let Booker25 know that it should use your class and where to find it.

  1. Go to Setup > Custom Settings

  2. Find the entry named ‘System Settings’ contained in the B25 package.

  3. Click Manage to the left of the ‘System Settings’ entry.

  4. Create a new Setting named ‘Reservation Form Customizer Class’.

  5. Set the String Value to the name of the class you created in the previous section.

  6. Save the setting.

Add an Event Handler

We will now add an event handler that listens for events generated when the user interacts with the form. In our example, we will create a handler that listens to the reservation’s status is changed, and which then updates the reservation’s title to reflect the current status.

  1. Create a new global Apex class. This can also be an inner class inside the MyFormLogic class that we created earlier. For simplicity, this is what we will do in all our code samples. In this example we will name our inner class MyStatusHandler.

  2. Have the new class extend the B25.FormEventHandler class. This means you will have to add the ‘handleEvent’ method.

  3. Inside the handleEvent method, add the following code that sets the title based on the status:

    1 2 3 4 5 6 7 Id newStatusId = (Id) event.getNewValue(); B25__Reservation_Status__c status = [ SELECT Name FROM B25__Reservation_Status__c WHERE Id = :newStatusId ]; form.getField(B25__Reservation__c.B25__Title__c).updateValue(status.Name);
  4. Inside the customize method of the MyFormLogic class, add the following line to make the form listen to changes in the status:

    1 form.getField(B25__Reservation__c.B25__Status__c).onUpdate(new MyStatusHandler());
  5. Save MyFormLogic. The entire file should now look something like this:

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 global with sharing class MyFormLogic implements B25.Form.Customizer { global void customize(B25.Form form) { // this is where we will add our handlers to the form form.getField(B25__Reservation__c.B25__Status__c).onUpdate(new MyStatusHandler()); } global with sharing class MyStatusHandler extends B25.FormEventHandler { global override void handleEvent(B25.FormEvent event, B25.Form form) { Id newStatusId = (Id) event.getNewValue(); B25__Reservation_Status__c status = [ SELECT Name FROM B25__Reservation_Status__c WHERE Id = :newStatusId ]; form.getField(B25__Reservation__c.B25__Title__c).updateValue(status.Name); } } }
  6. Test out your functionality by creating a new reservation on the calendar, and changing the status. You should be able to see the title change as well.

Add a Search Handler

Another way to extend the form is through search handlers. These allow you to modify the results being shown when the user searches in a lookup or a related list. A common use case for this is to narrow down the results. In this example we will narrow down the results showing up in the Reservation Contacts to only show contacts linked to the selected account.

  1. Add another inner class to the MyFormLogic class, but this time extending the B25.SearchHandler class. We will name our example class MyContactSearch.

  2. Override the ‘getSearchResults’ method defined in the B25.SearchHandler class. Inside the method, add the following logic:

    1 2 3 4 5 Id accountId = context.getForm().getReservation().B25__Account__c; if (accountId != null) { context.addCondition('AccountId = \'' + accountId + '\''); } return context.getDefaultResults();
  3. Inside the customize method of the MyFormLogic class, add the following line to make the form listen to searches in the reservation contact list:

    1 form.getRelatedList(B25__ReservationContact__c.SObjectType).onSearch(new MyContactSearch());
  4. Save MyFormLogic. The entire file should now look something like this:

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 global with sharing class MyFormLogic implements B25.Form.Customizer { global void customize(B25.Form form) { // this is where we will add our handlers to the form form.getField(B25__Reservation__c.B25__Status__c).onUpdate(new MyStatusHandler()); form.getRelatedList(B25__ReservationContact__c.SObjectType).onSearch(new MyContactSearch()); } global with sharing class MyStatusHandler extends B25.FormEventHandler { global override void handleEvent(B25.FormEvent event, B25.Form form) { Id newStatusId = (Id) event.getNewValue(); B25__Reservation_Status__c status = [ SELECT Name FROM B25__Reservation_Status__c WHERE Id = :newStatusId ]; form.getField(B25__Reservation__c.B25__Title__c).updateValue(status.Name); } } global with sharing class MyContactSearch extends B25.SearchHandler { global override B25.SearchResultCollection getSearchResults(B25.SearchContext context) { Id accountId = context.getForm().getReservation().B25__Account__c; if (accountId != null) { context.addCondition('AccountId = \'' + accountId + '\''); } return context.getDefaultResults(); } } }
  5. Test out your functionality by creating a new reservation on the calendar, and selecting an account. Now search for contacts to add, and you should only see results for the selected account.