Description

This method takes a dimension scope, a date range, and a prototype Reservation. It will return a list of available time ranges mapped by date and dimension.

Signature

global static B25.AvailableTimeRanges.Result getTimeRanges(B25.AvailableTimeRanges.Context context)

Parameters

B25.AvailableTimeRanges.Context

An instance of B25.AvailableTimeRanges.Context. This class wraps the input parameters, such as the dimension scope, a date range, and a prototype Reservation.

Return Type

B25.AvailableTimeRanges.Result

An instance of B25.AvailableTimeRanges.Result. This contains a list of available time ranges mapped by date and dimension.

Description

This class wraps the input parameters, such as the dimension scope, a date range, and a prototype Reservation.

Properties

Date startDate

The start of the date range that you are interested in. The result will not include available time ranges before this date. For performance reasons, try to keep the date range narrow.

Date endDate

The end of the date range that you are interested in. This date is exclusive. The result will not include available time ranges on or after this date. For performance reasons, try to keep the date range narrow.

String dimensionName

The name of the Dimension that you are interested in. A Dimension is an SObject that Reservations are related to. For example ‘B25__Resource__c’ or ‘B25__Staff__c’.

String dimensionFieldName

The name of the DimensionField that you are interested in. A DimensionField is a lookup from Reservation to a Dimension. For example ‘B25__Resource__c’ or ‘B25__Staff__c’.

Set<Id> dimensionIds

The collection of dimension record ids that you are interested in. For performance reasons, try to keep the size of this collection small.

B25__Reservation__c prototypeReservation

(Optional) If you have conflict checking configuration that depends on certain Reservation fields, you can include the prototypeReservation property with the required fields populated. An example could be that your configuration depends on B25__Quantity__c or B25__Status__r.B25__AllowDoubleBooking__c.

List<B25__Service_Reservation__c> serviceReservations

(Optional) If you include this property, the results will only include Resources where these Services are available with enough capacity. This property is only valid if your Dimension and Dimension Field are both set to ‘B25__Resource__c’.

Description

This class wraps the result, which contains a list of available time ranges mapped by date and dimension.

Properties

Map<Id, Map<Date, List<B25.AvailableTimeRanges.TimeRange>>> timeRanges

A list of time ranges, mapped by date, mapped by dimension id. The outer map will contain a key corresponding to each dimension id that was passed to the method in the dimensionIds property. The inner maps will contain a date key for each date in the date range (which were passed to the method in the startDate and endDate properties). The lists inside the inner maps will contain all the time ranges that the dimension is available on that date. If this list is empty, it means that the dimension is not available on that date.

Description

This class represents an available time range.

Properties

Time startTime

The time at which the dimension starts being available.

Time endTime

The time at which the dimension stops being available.