Versions Compared

Key

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

...

The RecurringReservations class enables developers to create a recurring series of Reservations. The method only creates reservationsReservations, but and does not insert or validate them. To validate the reservations, you can call B25.BulkReservationValidator.validate.

...

Panel
borderColorgrey
titlegenerateRecurringReservationSeries(Context context)

This method takes one or more lists of reservations Reservations wrapped in a Context class, and adds any detected soft or hard conflicts to them.

Expand
titledetails


Panel

Signature

Code Block
languagejava
global static B25.RecurringReservations.Result generateRecurringReservationSeries(B25.RecurringReservations.Context context)

Parameters

Code Block
languagejava
B25.RecurringReservations.Context

An instance of B25.RecurringReservations.Context. This object contains a prototype reservation Reservation (which will be cloned to create each reservation Reservation in the result), a recurring reservation Recurring Reservation record with all the recurrence settings, and some more optional parameters.

Return Type

Code Block
languagejava
B25.RecurringReservations.Result

This object contains the resulting series of reservationsReservations.




Inner Classes

Panel
borderColorgrey
titleContext class

This object contains a prototype reservation Reservation (which will be cloned to create each reservation Reservation in the result), a recurring reservation Recurring Reservation record with all the recurrence settings, and some more optional parameters.

Expand
titledetails


Panel
borderStylesolid
titleProperties

Properties

Code Block
languagejava
B25__Reservation__c prototype

This record will be cloned to create each reservation Reservation in the result. The only required fields on this record are B25__StartLocal__c and B25__EndLocal__c, which are used to define at what time of day the resulting reservations Reservations should start and end.

Code Block
B25__Recurring_Reservation__c recurringReservation

This record contains the recurrence settings that will define on which dates all the resulting reservations Reservations will occur. For more information about all the fields on this object, see the help texts on the B25__Recurring_Reservation__c object fields in setup. Additionally, you could consider creating a recurring reservation Reservation through the Booker25 UI, and then inspect the created B25__Recurring_Reservation__c object's field values.

Code Block
Set<String> skipUnavailabilityDimensions

This optional parameter can contain one or more names of dimensions. The creation algorithm will then skip any periods of times that these dimensions are unavailable. For example, if you are creating reservations Reservations for a staff member, and this staff member is on holiday for a week, this week will be skipped.



...

Panel
borderColorgrey
titleResult class

This class wraps the resulting series of B25__Reservation__c objects. Take note that these reservations Reservations have not yet been inserted or validated.

Expand
titledetails


Panel

Properties

Code Block
languagejava
List<B25__Reservation__c> reservations

This properties contains the resulting series of reservationsReservations. These reservations Reservations have not yet been inserted or validated. To validate the reservationsReservations, you can call B25.BulkReservationValidator.validate.



...