Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt
hiddentrue

Enables developers to find the ids of available dimensions (such as Staff or Resources) that are available for a single reservation.

This class of the Apex API allows you to find Dimension records that are available for a certain Reservation.


Panel
bgColorwhite
titleBGColorlightgray
borderStylesolid
titleMethods


Panel
borderStylesolid
titlefindAvailableDimensionIds(context)

Declaration

Code Block
languagejava
global static Set<Id> findAvailableDimensionIds(B25.AvailableDimensionIds.Context context)

Parameters

  • context (B25.AvailableDimensionIds.Context

Returns

  • Set<Id> The : The dimension IDs that would not result in any conflicts, if used for the given Reservation and Dimension Field.


Panel
borderStylesolid
titlefindSingleAvailableDimensionId(context)

This method checks, in compliance with the conflict detection engine, which dimensions are available for a given reservation, and then returns a single ID of one of the dimensions.

This is an invokable method and can be accessed from flows.

Declaration

Code Block
languagejava
global static List<AvailableDimensionIds.Result> findSingleAvailableDimensionId(List<AvailableDimensionIds.Context> contextList)

Parameters

  • contextList (List<B25.AvailableDimensionIds.Context>) : Only a single context needs to be passes. This property is a list in order to support bulkification.

Returns

  • List<AvailableDimensionIds.Result>: A result object that contains a single dimension ID and a list of dimension IDs that would not result in any conflicts, if used for the given Reservation and Dimension Field. Only a single result object will be returned, this property is a list in order to support bulkification.



Panel
bgColorwhite
titleBGColorlightgray
borderStylesolid
titleInner Classes


Panel
borderStylesolid
titleContext

Properties

  • reservation (B25__Reservation__c, Invocable Variable) - :Reservation you want to insert.
    • B25__StartLocal__c and B25__EndLocal__c need to be set.
    • Make sure that any fields that influence conflict checking are set (i.e. the quantity of the reservation, or B25__Status__r.B25__AllowDoubleBooking__c if your Dimension Field is configured to skip conflict checking when this field equals true), or the result might not contain all available dimensions.
  • dimensionFieldName (String) - Name , Invocable Variable): The name of the dimension field you want to search an available ID for. I.e. 'B25__Resource__c'.
  • dimensionIds (Set<Id>) - : Scope of dimension IDs to limit the search to. These have to be of the same type as the dimension field that you are searching in.

  • dimensionRecordIds (List<Id>, Invocable Variable): Scope of dimension IDs that the invocable method searches through.  This is a duplicate of the dimensionIds Set and is only used for B25.AvailableDimensionIds.findSingleAvailableDimensionId.
  • excludedReservationIds (Set<Id>) - : Reservation ids IDs to ignore in conflict checking. This allows you to exclude reservations you are in the process of moving.

    Note
    titledimensionIds

    The dimensionIds property narrows and dimensionRecordIds properties narrow down the search scope. This greatly improves performance for dimensions with many records. It is recommended to fill this parameter when searching in dimensions with a large amount of records.



Panel
borderStylesolid
titleResult

Properties

  • availableDimensionIds (List<Id>): A list of available dimension IDs
  • availableDimensionId (Id) - A single ID of the first dimension in availableDimensionIds list.


Example

The following example shows how you could implement the class to have it available in a Lightning Flowcan use B25.AvailableDimensionIds.findAvailableDimensionIds method:

Code Block
languagejava
public class DimensionSelector {

    @InvocableMethod(label='Get Dimensions' description='Returns available Dimension IDs' category='Scheduling')
    public static List<DimensionResult> getDimensions(List<DimensionSelector.DimensionRequest> requests) {      
        Set<Id> scopeIds = (new Map<Id,SObject>([select id from B25__Resource__c where B25__Resource_Type__r.Name = 'Personal Stylist'])).keySet();
        List<DimensionResult> allResults = new List<DimensionResult>();
        for (DimensionRequest request : requests) {
            allResults.add(DimensionSelector.getResultForRequest(request, scopeIds));
        }
        return allResults;
    }
   
    private static DimensionResult getResultForRequest(DimensionRequest request, Set<Id> scopeIds) {
        DimensionResult result = new DimensionResult();
        B25.AvailableDimensionIds.Context context = createContext(request.getReservation(), request.dimensionFieldName, scopeIds);
        result.dimensionIds = new List<Id>(B25.AvailableDimensionIds.findAvailableDimensionIds(context));
        return result;
    }

    public class DimensionResult {
        @InvocableVariable(Label='Available Dimension IDs')
        public List<Id> dimensionIds;
    }

    public class DimensionRequest {
        @InvocableVariable(Label='Start' Required=true)
        public Datetime startDateTime;
        @InvocableVariable(Label='End' Required=true)
        public Datetime endDateTime;
        @InvocableVariable(Label='Dimension Field Name' Required=true)
        public String dimensionFieldName;

        public B25Set<Id> getDimensions(B25__Reservation__c getReservation() {
            return new B25__Reservation__c(B25__StartLocal__c = startDateTime, B25__EndLocal__c = endDateTime);
        }
    }

    public static B25.AvailableDimensionIds.Context createContext(B25__Reservation__c reservationIn, String dimensionFieldNameIn, Set<ID> dimensionIdsIn) {
        B25.AvailableDimensionIds.Context context = new B25.AvailableDimensionIds.Context();
        context.reservation = reservationIn;
  
     context.dimensionFieldName = dimensionFieldNameIn;
        context.dimensionIds = dimensionIdsIn;
   
    return B25.AvailableDimensionIds.findAvailableDimensionIds(context);
    }

}


Related articles

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@101b6
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "apexapi" and type = "page" and space = "BPD"
labelsApexApi

Page Properties
hiddentrue


Related issues




Panel
titleOn this page

Table of Contents


...