global static ffrr.RevenueScheduleService.DeleteResult deleteOrphanedSchedules(Set<Id> scheduleIds)

Processes List of ffrr__RevenueSchedule__c Id for deletion. If there are no ffrr__RevenueScheduleLine__c marked complete for the schedule and if there is no source, the source does not have a template mapped, or the source is marked inactive then the schedule will be deleted.
If there are ffrr__RevenueScheduleLine__c marked complete for the schedule then all ffrr__RevenueScheduleLine__c that are not complete will be deleted and the ffrr__RevenueSchedule__c will be marked source unavailable.

Input Parameters

Return Value

DeleteResult for the deleteOrphanedSchedules process

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to synchronously delete schedules
// that are missing source records, and return the DeleteResult object.
// If a schedule has no source record but contains recognized schedule lines, then only
// the unrecognized lines are deleted.

// Retrieve the Ids of the Recognition Schedules that will be used as the recognition schedule Ids from which to delete orphaned Recognition Schedules
List<ffrr__RevenueSchedule__c> revenueSchedules = [SELECT Id FROM ffrr__RevenueSchedule__c WHERE ffrr__Account__r.Name = 'FF'];
Set<Id> revenueScheduleIds = new Set<Id>();

for( ffrr__RevenueSchedule__c revenueSchedule : revenueSchedules )
{
    revenueScheduleIds.add(revenueSchedule.Id);
}

// Get the DeleteResult for the process
ffrr.RevenueScheduleService.DeleteResult result = ffrr.RevenueScheduleService.deleteOrphanedSchedules(revenueScheduleIds);

Set<Id> fullyDeletedScheduleIds = result.getFullyDeletedScheduleIds();
Set<Id> partiallyDeletedScheduleIds = result.getPartiallyDeletedScheduleIds();
Set<Id> nonDeletedScheduleIds = result.getNonDeletedScheduleIds();
Set<Id> nonDeletedScheduleLineIds = result.getNonDeletedScheduleLineIds();
Map<Id, List<String>> errorsByScheduleIds = result.getErrorsByScheduleIds();

global static Id deleteOrphanedSchedulesAsync()

Processes ffrr__RevenueSchedule__c for deletion If there are no ffrr__RevenueScheduleLine__c marked complete for the schedule then the schedule will be deleted if there is no source, the source does not have a template mapped, or the source is marked inactive. If there are ffrr__RevenueScheduleLine__c marked complete for the schedule then ffrr__RevenueScheduleLine__c that are not recognized will be deleted.

Return Value

Id of the executing ffrr__RevenueManagementBackgroundProcess__c record.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to asynchronously delete schedules
// that are missing source records, and return the Async Apex Job Id.
// If a schedule has no source record but contains recognized schedule lines, then only
// the unrecognized lines are deleted.

// Get the Id of Async Apex Job generating the Recognition Schedules
Id jobId = ffrr.RevenueScheduleService.deleteOrphanedSchedulesAsync();

// Get AsyncApexJob status
List<AsyncApexJob> asyncJob = [SELECT Id, Status FROM AsyncApexJob WHERE Id = :jobId];

global static List<Id> generate(Set<Id> sourceRecordIds)

Takes a set of source record Id and generates and inserts ffrr__RevenueSchedule__c and associated ffrr__RevenueScheduleLine__c. The ffrr__RevenueSchedule__c and ffrr__RevenueScheduleLine__c are populated with information from the source record, as defined by the associated ffrr__Settings__c, using the calculation type from the associated ffrr__Template__c.
Note: The appropriate ffrr__Settings__c and ffrr__Template__c must be set up for a source record and its type.

Input Parameters

Return Value

List of ffrr__RevenueSchedule__c.Id generated for sourceRecordIds.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to create a Recognition Schedule for each
// source record Id passed in to the service method, and return a list of associated Recognition Schedule Ids
// If any of the sources are not set up for revenue recognition then no schedules will be generated.

// Retrieve the Ids of the Performance Obligations that will be used as the source Ids from which to generate Recognition Schedules
List<ffrr__PerformanceObligation__c> sourceRecords = [SELECT Id FROM ffrr__PerformanceObligation__c WHERE ffrr__AccountName__c = 'FF'];
Set<Id> sourceRecordIds = new Set<Id>();

for( ffrr__PerformanceObligation__c sourceRecord : sourceRecords )
{
    sourceRecordIds.add(sourceRecord.Id);
}

// Get the List of Recognition Schedule Ids that have been generated by this service
List<Id> revenueScheduleIds = ffrr.RevenueScheduleService.generate(sourceRecordIds);

global static Map<Id, ffrr.RevenueScheduleService.GenerateResult> generate(Set<Id> sourceRecordIds, ffrr.RevenueScheduleService.GenerateConfig config)

Takes a set of source record Id and generates and inserts or updates ffrr__RevenueSchedule__c and associated ffrr__RevenueScheduleLine__c. The ffrr__RevenueSchedule__c and ffrr__RevenueScheduleLine__c are populated with information from the source record, as defined by the associated ffrr__Settings__c, using the calculation type from the associated ffrr__Template__c.
Note: The appropriate ffrr__Settings__c and ffrr__Template__c must be set up for a source record and its type.

Input Parameters

Return Value

Map of source record Id to GenerateResult for the processed records.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to create a Recognition Schedule for each
// source record Id passed in to the service method, and return a map of source Ids to associated results.
// The generate method is called with a GenerateConfig object that sets the all or none parameter to false.
// If a source is not set up for revenue recognition then no schedules will be generated for it.
// If a source is set up for revenue recognition then a schedule will be generated for it.

// Retrieve the Ids of the Performance Obligations that will be used as the source Ids from which to generate Recognition Schedules
List<ffrr__PerformanceObligation__c> sourceRecords = [SELECT Id FROM ffrr__PerformanceObligation__c WHERE ffrr__AccountName__c = 'FF'];
Set<Id> sourceRecordIds = new Set<Id>();

for( ffrr__PerformanceObligation__c sourceRecord : sourceRecords )
{
    sourceRecordIds.add(sourceRecord.Id);
}

ffrr.RevenueScheduleService.GenerateConfig config = new ffrr.RevenueScheduleService.GenerateConfig();
config.allOrNone = false;

// Get the results that have been generated by this service
Map<Id, ffrr.RevenueScheduleService.GenerateResult> results = ffrr.RevenueScheduleService.generate(sourceRecordIds, config);

for(Id sourceId : results.keySet()) {
  ffrr.RevenueScheduleService.GenerateResult result = results.get(sourceId);
  // Log the Id of the source record for which this result is associated with
  System.debug('Source Record Id ' + result.sourceRecordId);
  // Log the Id of the schedule  that was generated
  System.debug('Schedule Id ' + result.scheduleId);
  // Log the status of the generate for this source record Id
  System.debug('Success ' + result.success);
  // Log any errors that were thrown
  for(String e : result.errors) {
    System.debug('error: ' + e);
  }
}

global static Id generateAsync()

Generates and inserts or updates ffrr__RevenueRecognitionSchedule__c and associated ffrr__RevenueRecognitionScheduleLine__c asynchronously for all valid source records available in the Org. The ffrr__RevenueSchedule__c and ffrr__RevenueScheduleLine__c are populated with information from the source record, as defined by the associated ffrr__Settings__c, using the calculation type from the associated ffrr__Template__c.
Note: The appropriate ffrr__Settings__c and ffrr__Template__c must be set up for a source record, and its type.

Return Value

Id of the executing ffrr__RevenueManagementBackgroundProcess__c record.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to asynchronously create a Recognition Schedule for each
// available source record in the org, and return the Async Apex Job Id.
// If a source is not set up for revenue recognition then no schedules will be generated for it.
// If a source is set up for revenue recognition then a schedule will be generated for it.

// Get the Id of Async Apex Job generating the Recognition Schedules
Id batchJobId = ffrr.RevenueScheduleService.generateAsync();

// Get AsyncApexJob status
List<AsyncApexJob> batchJob = [SELECT Id, Status FROM AsyncApexJob WHERE Id = :batchJobId];

global static Id generateAsync(Set<Id> sourceRecordIds)

Takes a set of source record Id and generates and inserts or updates ffrr__RevenueSchedule__c and associated ffrr__RevenueScheduleLine__c asynchronously. The ffrr__RevenueSchedule__c and ffrr__RevenueScheduleLine__c are populated with information from the source record, as defined by the associated ffrr__Settings__c, using the calculation type from the associated ffrr__Template__c.
Note: The appropriate ffrr__Settings__c and ffrr__Template__c must be set up for a source record and its type.

Input Parameters

Return Value

Id of the executing ffrr__RevenueManagementBackgroundProcess__c record.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to asynchronously create a Recognition Schedule for each
// source record Id passed in to the service method, and return the Async Apex Job Id.
// If a source is not set up for revenue recognition then no schedules will be generated for it.
// If a source is set up for revenue recognition then a schedule will be generated for it.

// Retrieve the Ids of the Performance Obligations that will be used as the source Ids from which to generate Recognition Schedules
List<ffrr__PerformanceObligation__c> sourceRecords = [SELECT Id FROM ffrr__PerformanceObligation__c WHERE ffrr__AccountName__c = 'FF'];
Set<Id> sourceRecordIds = new Set<Id>();

for( ffrr__PerformanceObligation__c sourceRecord : sourceRecords )
{
    sourceRecordIds.add(sourceRecord.Id);
}

// Get the Id of Async Apex Job generating the Recognition Schedules
Id batchJobId = ffrr.RevenueScheduleService.generateAsync(sourceRecordIds);

// Get AsyncApexJob status
List<AsyncApexJob> batchJob = [SELECT Id, Status FROM AsyncApexJob WHERE Id = :batchJobId];

global static ffrr.RevenueScheduleService.RecognizeResult recognize(Set<Id> revenueScheduleLineIds, ffrr.RevenueScheduleService.RecognitionInformation recognitionInformation)

Recognizes revenue for the given Set of ffrr__RevenueScheduleLine__c.Id

Input Parameters

Return Value

RecognizeResult for the recognized ffrr__RevenueScheduleLine__c

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to create a Recognition Transaction for each
// Recognition Schedule Line Id passed in to the service method.
// The recognize method is called with a RecognitionInformation object that sets the recognition date.

// Retrieve the Ids of the Recognition Schedule Lines that will be used to create Recognition Transactions from.
Map<Id, ffrr__RevenueScheduleLine__c> scheduleLinesByIds = new Map<Id, ffrr__RevenueScheduleLine__c>([SELECT Id, Name FROM ffrr__RevenueScheduleLine__c]);

ffrr.RevenueScheduleService.RecognitionInformation recognitionInformation = new ffrr.RevenueScheduleService.RecognitionInformation();
recognitionInformation.setRecognitionDate(Date.newInstance(2022, 01, 31));

// Get the results that have been generated by this service
ffrr.RevenueScheduleService.RecognizeResult result = ffrr.RevenueScheduleService.recognize(scheduleLinesByIds.keySet(), recognitionInformation);

for(Id successfulLineId : result.getSuccessfulLineIds()) {
  System.debug('Successful Line Id ' + successfulLineId);
}
for(Id invalidLineId : result.getInvalidLineIds()) {
  System.debug('Invalid Line Id ' + invalidLineId);

  for(String error : result.getErrorsForId(invalidLineId)) {
    System.debug('Error ' + error);
  }
}

global static Id recognizeAsync(ffrr.RevenueScheduleService.RecognitionFilters recognitionFilters, ffrr.RevenueScheduleService.RecognitionInformation recognitionInformation)

Recognizes revenue for the ffrr__RevenueScheduleLine__c described by recognitionFilters.

Input Parameters

Return Value

Id of the executing ffrr__RevenueManagementBackgroundProcess__c record.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to asynchronously create a Recognition Transaction with associated lines for each
// source record type and revenue stream based on the Recognition Schedule Line Id passed in to the service method.
// If the provided ffrr.RecognitionFilters configuration object has no fromDate all valid records from start of time will be retrieved
// If the provided ffrr.RecognitionFilters configuration object has no untilDate all valid records until end of time will be retrieved
// If the provided ffrr.RecognitionFilters configuration object has no revenueScheduleLineIds all valid records will be retrieved in conjunction of the fromDate and untilDate

// Retrieve the Ids of the Recognition Schedule Lines that will be used to create Recognition Transactions from.
Map<Id, ffrr__RevenueScheduleLine__c> scheduleLinesByIds = new Map<Id, ffrr__RevenueScheduleLine__c>([SELECT Id, Name FROM ffrr__RevenueScheduleLine__c]);

ffrr.RevenueScheduleService.RecognitionFilters recognitionFilters = new ffrr.RevenueScheduleService.RecognitionFilters();
recognitionFilters.setFromDate(Date.newInstance(2022, 01, 01));
recognitionFilters.setUntilDate(Date.newInstance(2022, 01, 31));

ffrr.RevenueScheduleService.RecognitionInformation recognitionInformation = new ffrr.RevenueScheduleService.RecognitionInformation();
recognitionInformation.setRecognitionDate(Date.newInstance(2022, 01, 31));

// Sets the optional recognition schedule line Ids to be taken into consideration when recognizing schedules
recognitionFilters.setRevenueScheduleLineIds(scheduleLinesByIds.keySet());

// Calls recognition service
ffrr.RevenueScheduleService.recognizeAsync(recognitionFilters, recognitionInformation);

global static ffrr.RevenueScheduleService.SynchronizeResult synchronize(Set<Id> sourceRecordIds)

Synchronizes ffrr__RevenueSchedule__c with their associated source records If a source record has become unavailable and there are no ffrr__RevenueScheduleLine__c marked complete for the schedule, then the ffrr__RevenueSchedule__c and all its ffrr__RevenueScheduleLine__c will be deleted. A source record can become unavailable if it has been deleted, if it does not have a template, or if it is marked inactive.
If a source record has become unavailable and there are ffrr__RevenueScheduleLine__c marked complete for the schedule, then any ffrr__RevenueScheduleLine__c that are not recognized will be deleted. Complete and Opening Balance lines persist.
If a source record has changed then the associated ffrr__RevenueSchedule__c and its ffrr__RevenueScheduleLine__c will be updated to reflect the changes.

Input Parameters

Return Value

SynchronizeResult for the processed records.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to synchronize Recognition Schedules for each
// source record Id passed in to the service method, and return a SynchronizeResult object
// containing information about how the process completed

// Retrieve the Ids of the Performance Obligations that will be used as the source Ids from which to synchronize Recognition Schedules
List<ffrr__PerformanceObligation__c> sourceRecords = [SELECT Id FROM ffrr__PerformanceObligation__c WHERE ffrr__AccountName__c = 'FF'];
Set<Id> sourceRecordIds = new Set<Id>();

for( ffrr__PerformanceObligation__c sourceRecord : sourceRecords )
{
    sourceRecordIds.add(sourceRecord.Id);
}

// Get the SynchronizeResult, any errors will be thrown as an exception
ffrr.RevenueScheduleService.SynchronizeResult result = ffrr.RevenueScheduleService.synchronize(sourceRecordIds);
Set<Id> generatedSchedulesSourceIds = result.getGeneratedSchedulesSourceIds();
System.debug('Generated Schedules Source Ids');
for(Id sourceIds : generatedSchedulesSourceIds) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithFullyDeletedSchedules = result.getSourceIdsWithFullyDeletedSchedules();
System.debug('Source Ids With Fully Deleted Schedules');
for(Id sourceIds : sourceIdsWithFullyDeletedSchedules) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithPartiallyDeletedSchedules = result.getSourceIdsWithPartiallyDeletedSchedules();
System.debug('Source Ids With Partially Deleted Schedules');
for(Id sourceIds : sourceIdsWithPartiallyDeletedSchedules) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithNonDeletedSchedules = result.getSourceIdsWithNonDeletedSchedules();
System.debug('Source Ids With Non Deleted Schedules');
for(Id sourceIds : sourceIdsWithNonDeletedSchedules) {
  System.debug(sourceIds);
}

global static ffrr.RevenueScheduleService.SynchronizeResult synchronize(Set<Id> sourceRecordIds, ffrr.RevenueScheduleService.SynchronizeConfig config)

Synchronizes ffrr__RevenueSchedule__c with their associated source records If a source record has become unavailable and there are no ffrr__RevenueScheduleLine__c marked complete for the schedule, then the ffrr__RevenueSchedule__c and all its ffrr__RevenueScheduleLine__c will be deleted. A source record can become unavailable if it has been deleted, if it does not have a template, or if it is marked inactive.
If a source record has become unavailable and there are ffrr__RevenueScheduleLine__c marked complete for the schedule, then any ffrr__RevenueScheduleLine__c that are not recognized will be deleted. Complete and Opening Balance lines persist.
If a source record has changed then the associated ffrr__RevenueSchedule__c and its ffrr__RevenueScheduleLine__c will be updated to reflect the changes.

Input Parameters

Return Value

SynchronizeResult for the processed records.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// In this example the Revenue Schedule Service is used to synchronize Recognition Schedules for each
// source record Id passed in to the service method, and return a SynchronizeResult object
// containing information about how the process completed. This example uses a configuration object
// to set up how synchronize should be performed.

// Retrieve the Ids of the Performance Obligations that will be used as the source Ids from which to synchronize Recognition Schedules
List<ffrr__PerformanceObligation__c> sourceRecords = [SELECT Id FROM ffrr__PerformanceObligation__c WHERE ffrr__AccountName__c = 'FF'];
Set<Id> sourceRecordIds = new Set<Id>();

for( ffrr__PerformanceObligation__c sourceRecord : sourceRecords )
{
    sourceRecordIds.add(sourceRecord.Id);
}

ffrr.RevenueScheduleService.SynchronizeConfig config = new ffrr.RevenueScheduleService.SynchronizeConfig();
config.allOrNone = false;

// Get the SynchronizeResult, with this config any errors will be logged rather than thrown
ffrr.RevenueScheduleService.SynchronizeResult result = ffrr.RevenueScheduleService.synchronize(sourceRecordIds, config);
Set<Id> generatedSchedulesSourceIds = result.getGeneratedSchedulesSourceIds();
System.debug('Generated Schedules Source Ids');
for(Id sourceIds : generatedSchedulesSourceIds) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithFullyDeletedSchedules = result.getSourceIdsWithFullyDeletedSchedules();
System.debug('Source Ids With Fully Deleted Schedules');
for(Id sourceIds : sourceIdsWithFullyDeletedSchedules) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithPartiallyDeletedSchedules = result.getSourceIdsWithPartiallyDeletedSchedules();
System.debug('Source Ids With Partially Deleted Schedules');
for(Id sourceIds : sourceIdsWithPartiallyDeletedSchedules) {
  System.debug(sourceIds);
}
Set<Id> sourceIdsWithNonDeletedSchedules = result.getSourceIdsWithNonDeletedSchedules();
System.debug('Source Ids With Non Deleted Schedules');
for(Id sourceIds : sourceIdsWithNonDeletedSchedules) {
  System.debug(sourceIds);
}

Map<Id, List<String>> allErrorsBySourceIds = result.getAllErrorsBySourceIds();
System.debug('Get All Errors By Source Ids');
for(Id sourceId : allErrorsBySourceIds.keySet()) {
  List<String> errorMessages = result.getErrorsForSourceId(sourceId);
  System.debug('Source Id ' + sourceId);
  for(String errorMessage : errorMessages) {
    System.debug(errorMessage);
  }
}

global GenerateConfig()

global RecognitionFilters()

global void setFromDate(Date fromDate)

Sets the date (inclusive) after which we start taking Recognition Schedule Lines into consideration for recognition.

Input Parameters

global void setUntilDate(Date untilDate)

Sets the date (inclusive) until we stop taking Recognition Schedule Lines into consideration for recognition.

Input Parameters

global void setRevenueScheduleLineIds(Set<Id> revenueScheduleLineIds)

Sets the optional recognition schedule line Ids to be taken into consideration when recognizing schedules. If any schedules are passed to this method then only those schedule lines will be recognized, otherwise all valid schedule lines will be recognized.

Input Parameters

global void setRevenueScheduleLineIds(List<Id> revenueScheduleLineIds)

Sets the optional recognition schedule line Ids to be taken into consideration when recognizing schedules. If any schedules are passed to this method then only those schedule lines will be recognized, otherwise all valid schedule lines will be recognized.

Input Parameters

global RecognitionInformation()

global void setRecognitionDate(Date recognitionDate)

Sets the date which will appear on all the Recognition Transaction Lines as their recognition date

Input Parameters

global RecognizeResult()

global Set<Id> getSuccessfulLineIds()

global Set<Id> getInvalidLineIds()

global Set<String> getErrorsForId(Id invalidID)

global Set<Id> getFullyDeletedScheduleIds()

public no args constructor to prevent instantiation of a result object outside of the managed package.

global Set<Id> getPartiallyDeletedScheduleIds()

global Set<Id> getNonDeletedScheduleIds()

global Set<Id> getNonDeletedScheduleLineIds()

global Map<Id, List<String>> getErrorsByScheduleIds()

global SynchronizeConfig()

global Set<Id> getGeneratedSchedulesSourceIds()

public no args constructor to prevent instantiation of a result object outside of the managed package.

global Set<Id> getSourceIdsWithFullyDeletedSchedules()

global Set<Id> getSourceIdsWithPartiallyDeletedSchedules()

global Set<Id> getSourceIdsWithNonDeletedSchedules()

global Id getScheduleIdForSourceId(Id sourceId)

global List<String> getErrorsForSourceId(Id sourceId)

global Map<Id, List<String>> getAllErrorsBySourceIds()