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 dimension IDs that would not result in any conflicts, if used for the given Reservation and Dimension Field.




Panel
bgColorwhite
titleBGColorlightgray
borderStylesolid
titleInner Classes


Panel
borderStylesolid
titleContext

Properties

  • reservation (B25__Reservation__c) - 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 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.


  • excludedReservationIds (Set<Id>) - Reservation 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 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.




Related articles

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


...