BulkReservationValidator
The BulkReservationValidator enables developers to validate one or more series of Reservations. It will return all the soft and hard conflicts that would arise, given the current configuration. For more information on how to configure conflict checking, see this article.
Methods
This method takes one or more lists of reservations wrapped in a Context class, and adds any detected soft or hard conflicts to them.
Signature
global static B25.BulkReservationValidator.Result validate(B25.BulkReservationValidator.Context context)
Parameters
B25.BulkReservationValidator.Context
An instance of B25.BulkReservationValidator.Context. This class wraps the series of reservations to be validated.
Return Type
B25.BulkReservationValidator.Result
This is a dummy class without properties. This allows us to add properties later without changing the method signature. For now, developers can ignore the result, because the validation results are added to the individual B25.BulkReservationValidator.Reservation instances that were passed as the input.
Inner Classes
This class wraps the series of reservations to be validated.
Properties
List<List<B25.BulkReservationValidator.Reservation>> reservationSeries
This is a nested list of B25.BulkReservationValidator.Reservation instances, which are the wrappers around the reservations to be validated.
This class wraps a B25__Reservation__c object, as well as related child objects of the reservation. It has two additional properties, softConflicts and hardConflicts, which will be set by the validate method.
Properties
B25__Reservation__c record
The record that you want to validate. Any related child records should be added to the childRecords property.
Map<String, List<SObject>> childRecords
This map allows you to specify related child records that should also be validated, such as a list of ReservationContacts. Use the relationship name as the key (so 'B25__ReservationContacts__r' for example).
List<B25__Conflict__c> softConflicts
This property will be set by the validate method. It will contain all the soft conflicts that would be generated if the Reservation would be saved to the database.
List<B25__Conflict__c> hardConflicts
This property will be set by the validate method. It will contain all the hard conflicts that would be generated if the Reservation would be saved to the database.
This is a dummy class without properties. This allows us to add properties later without changing the method signature. For now, developers can ignore the result, because the detected are added to the individual B25.BulkReservationValidator.Reservation instances that were passed as the input.
Example
B25__Resource__c resource = [SELECT Id FROM B25__Resource__c WHERE Name = 'Resource One'];
B25__Staff__c staffMember = [SELECT Id FROM B25__Staff__c WHERE Name = 'Staff Member One'];
// first construct the context parameter
B25.BulkReservationValidator.Context context = new B25.BulkReservationValidator.Context();
context.reservationSeries = new List<List<B25.BulkReservationValidator.Reservation>>{
new List<B25.BulkReservationValidator.Reservation>{
new B25.BulkReservationValidator.Reservation(
new B25__Reservation__c(
B25__StartLocal__c = Datetime.newInstance(2020, 1, 1, 8, 0, 0),
B25__EndLocal__c = Datetime.newInstance(2020, 1, 1, 10, 0, 0),
B25__Resource__c = resource.Id,
B25__Staff__c = staffMember.Id
)
),
new B25.BulkReservationValidator.Reservation(
new B25__Reservation__c(
B25__StartLocal__c = Datetime.newInstance(2020, 2, 2, 14, 0, 0),
B25__EndLocal__c = Datetime.newInstance(2020, 2, 2, 16, 0, 0),
B25__Resource__c = resource.Id,
B25__Staff__c = staffMember.Id
)
)
}
};
// then call the method
B25.BulkReservationValidator.validate(context);
// the reservations in the context parameter now have soft and hard conflicts
for (B25.BulkReservationValidator.Reservation reservation : context.reservationSeries[0]) {
System.debug('number of soft conflicts: ' + reservation.softConflicts.size());
System.debug('number of hard conflicts: ' + reservation.hardConflicts.size());
}