Reporting API Documentation

ffr.SummarizationService

global with sharing class SummarizationService

The service class relating to Summarization in FinancialForce Accounting.

Date

2015

Methods

getAvailableSummarizationObjects

global static List<ffr.SummarizationService.Destination> getAvailableSummarizationObjects(String objectNameFragment)

getTemplates

global static List<ffr.SummarizationService.SummarizationTemplate> getTemplates(Set<Id> templateIds)

saveTemplates

global static List<Id> saveTemplates(Set<ffr.SummarizationService.SummarizationTemplate> templates)

runSummarization

global static void runSummarization(Set<Id> summarizationTemplateIds)

saveAndRunSummarizationTemplates

global static List<Id> saveAndRunSummarizationTemplates(Set<ffr.SummarizationService.SummarizationTemplate> templates)

purgeTemplateData

global static void purgeTemplateData(Set<id> templatesToPurge)

scheduleSummarization

global static void scheduleSummarization(Set<Id> summarizationTemplateIds, ffr.CronSpec cron)

unscheduleSummarization

global static void unscheduleSummarization(Set<Id> summarizationTemplateIds)

ffr.SummarizationService.Filter

global class Filter implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the Filter__c SObject. A Filter contains a number of filter elements to define the rules to be imposed on a particular field of a table (SObject). These rules determine the inclusion of data in particular cells of the specified field.

This class implements the following interfaces:

Properties

Name Type Description
id Id
filterElements List<ffr.SummarizationService.FilterElement>

Methods

Filter

global Filter()

Filter

global Filter(ffr__Filter__c filterSobject)

createSObject

global ffr__Filter__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.FilterElement

global class FilterElement implements ISummarizationServiceObject, Comparable

A data transfer object (DTO) that corresponds to the FilterElement__c SObject. A FilterElement defines the rules to be imposed on a particular field of a table (SObject). These rules determine the inclusion of data in particular cells of the specified field.

This class implements the following interfaces:

Properties

Name Type Description
id Id
operator String
field String
fromValue String
toValue String
openingBrackets Decimal
closingBrackets Decimal
combineType String
index Decimal

Methods

FilterElement

global FilterElement()

FilterElement

global FilterElement(ffr__FilterElement__c filterElementSobject)

createSObject

global ffr__FilterElement__c createSObject()

compareTo

global Integer compareTo(Object compareTo)

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.SummarizationTemplate

global class SummarizationTemplate implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the SummarizationTemplate__c SObject. A summarization template groups all the objects relating to one summarization template.

This class implements the following interfaces:

Properties

Name Type Description
id Id
Dataview ffr.CommonService.Identity
name String
destination String
objectToObjectMap ffr.SummarizationService.ObjectToObjectMap
filter ffr.SummarizationService.Filter
fieldProcesses List<ffr.SummarizationService.SummarizationTemplateFieldProcess>
basePeriod String Holds the current reference period for resolving soft-period calculations.
DEPRECATED: No longer in use.
useCurrentPeriod
Boolean Flag to use the current period as base period.

Methods

SummarizationTemplate

global SummarizationTemplate()

SummarizationTemplate

global SummarizationTemplate(ffr__SummarizationTemplate__c summarizationTemplate)

createSObject

global ffr__SummarizationTemplate__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.SummarizationRunInformation

global class SummarizationRunInformation implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the SummarizationRunInformation__c SObject. Contains information on when the template was last used in the summarization process and if it was successful

This class implements the following interfaces:

Properties

Name Type Description
id Id
startTime Datetime
endTime Datetime
lastAttemptedInstance Decimal
lastSuccessfulInstance Decimal

Methods

SummarizationRunInformation

global SummarizationRunInformation()

SummarizationRunInformation

global SummarizationRunInformation(ffr__SummarizationRunInformation__c summarizationRunInfo)

createSObject

global ffr__SummarizationRunInformation__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.SummarizationTemplateFieldProcess

global class SummarizationTemplateFieldProcess implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the SummarizationTemplateFieldProcess__c SObject. A summarization template field process object defines the means of aggregation to be imposed upon a particular field.

This class implements the following interfaces:

Properties

Name Type Description
id Id
fieldName String
process String

Methods

SummarizationTemplateFieldProcess

global SummarizationTemplateFieldProcess()

SummarizationTemplateFieldProcess

global SummarizationTemplateFieldProcess(ffr__SummarizationTemplateFieldProcess__c summarizationTemplateFieldProcessSObject)

createSObject

global ffr__SummarizationTemplateFieldProcess__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.ObjectToObjectMap

global class ObjectToObjectMap implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the ObjectToObjectMap__c SObject. An ObjectToObjectMap represents how one or more SObject's fields link to another's, or to several other SObjects' fields.

This class implements the following interfaces:

Properties

Name Type Description
id Id
objectToObjectMapFieldLinks List<ffr.SummarizationService.ObjectToObjectMapFieldLink>

Methods

ObjectToObjectMap

global ObjectToObjectMap()

ObjectToObjectMap

global ObjectToObjectMap(ffr__ObjectToObjectMap__c objectToObjectMapSobject)

createSObject

global ffr__ObjectToObjectMap__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.ObjectToObjectMapFieldLink

global class ObjectToObjectMapFieldLink implements ISummarizationServiceObject

A data transfer object (DTO) that corresponds to the ObjectToObjectMapFieldLink__c SObject. An ObjectToObjectMapFieldLink defines the association between a field on one SObject and a field on another.

This class implements the following interfaces:

Properties

Name Type Description
id Id
fromField String
toField String
filter ffr.SummarizationService.Filter
displayOrder Decimal

Methods

ObjectToObjectMapFieldLink

global ObjectToObjectMapFieldLink()

ObjectToObjectMapFieldLink

global ObjectToObjectMapFieldLink(ffr__ObjectToObjectMapFieldLink__c objectToObjectMapFieldLinkSobject)

createSObject

global ffr__objectToObjectMapFieldLink__c createSObject()

equals

global Boolean equals(Object obj)

hashCode

global Integer hashCode()

ffr.SummarizationService.Destination

global class Destination

A data transfer object (DTO) that specifies a destination object for the summarization process. This object is read only.

Properties

Name Type Description
objectName String
objectLabel String

ffr.SummarizationService.DestinationField

global class DestinationField

Properties

Name Type Description
DestinationFieldName String
DestinationFieldLabel String
Type Schema.DisplayType

Methods

DestinationField

global DestinationField()

DestinationField

global DestinationField(String name, String label)

DestinationField

global DestinationField(String name, String label, Schema.DisplayType fieldType)

ffr.SummarizationService.ISummarizationServiceObject

global interface ISummarizationServiceObject

Methods

createSObject

SObject createSObject()

© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.