Reporting API Documentation
|
ffr.ActionViewsServiceglobal with sharing class ActionViewsService The service class relating to Online Inquiries. Date2016 EnumsMessageLevelThe type of status message returned by the action.
Methods
hasPromptsglobal static Boolean hasPrompts(ffr.InquiryTemplateService.InquiryTemplate template) Returns a Boolean indicating whether or not the specified action view template has criteria set to prompt. Input Parameters
Return ValueTrue if there are any prompts to perform at run-time. getDataglobal static ffr.SelectionService.Result getData(ffr.InquiryTemplateService.InquiryTemplate template) Retrieves the data that is returned when you run an Action View using the specified template. Input Parameters
Return ValueThe selected data. getDataglobal static ffr.SelectionService.Result getData(Id dataviewId, String basePeriod, List<Id> fieldList, List<ffr.InquiryTemplateService.InquiryTemplateFilter> filterList) Retrieves the data that is returned when you run an Action View using the specified parameters. Input Parameters
Return ValueThe selected data. getDataglobal static ffr.SelectionService.Result getData(Id dataviewId, String basePeriod, List<Id> fieldList, List<ffr.InquiryTemplateService.InquiryTemplateFilter> filterList, Map<Id, List<ffr.DataViewService.DataViewJoinFilter>> joinFilterMap) Retrieves the data that is returned when you run an Action View using the specified parameters. Input Parameters
Return ValueThe selected data. getDrillDataglobal static ffr.ActionViewsService.DrillData getDrillData(ID sourceTemplateID, ID destinationTemplateID, String basePeriod, List<ffr.InquiryTemplateService.InquiryTemplateFilter> currentfilterList, List<ffr.InquiryTemplateService.InquiryTemplateFilter> columnFilters, List<ffr.InquiryTemplateService.InquiryTemplateFilter> summarizationTemplateFilterList, Map<String, String> drillContext) Applies column filters, when doing a drill, to ensure that the drill results are specific to the value in the filtered column, rather than including values across the whole row. Input Parameters
Return ValueThis data from the drill operation along with it's action view template. getPersonalSettingsForTemplateAndUserglobal static ffr.ActionViewsService.ActionViewsPersonalSetting getPersonalSettingsForTemplateAndUser(Id templateId) Retrieves the personal settings that have been saved by the current user for the specified action view template. Input Parameters
Return ValuePersonal settings for the current user and the specified template. savePersonalSettingsglobal static ffr.ActionViewsService.ActionViewsPersonalSetting savePersonalSettings(ffr.ActionViewsService.ActionViewsPersonalSetting settingsDTO) Saves the specified personal settings. Input Parameters
Return ValueNew personal settings for the current user. deletePersonalSettingglobal static void deletePersonalSetting(Id templateId) Deletes the personal settings that have been saved by the current user for the specified action view template. Input Parameters
invokeActionglobal static ffr.ActionViewsService.ActionResult invokeAction(Id dataviewId, Id actionId, ffr.SelectionService.Result selectedData, Map<String, String> promptValues) Invokes an Action Views action using the specified parameters. Input Parameters
Return ValueThis service returns a c2g.ActionViewsService.ActionResult object. Validateglobal static ffr.ActionViewsService.ValidationResult Validate(Id dataviewId, Id actionId, ffr.SelectionService.Result selectedData) Verifies whether the specified action is valid for the selected data. Input Parameters
Return ValueThis service returns a c2g.ActionViewsService.ValidationResult object. ffr.ActionViewsService.DrillDataglobal class DrillData Holds information used when drilling within Online Inquiries. Properties
ffr.ActionViewsService.ActionViewsPersonalSettingglobal class ActionViewsPersonalSetting Properties
Methods
ActionViewsPersonalSettingglobal ActionViewsPersonalSetting() Creates an API version of an empty online inquiries personal setting object. Return ValueThis constructor does not return a value. ActionViewsPersonalSettingglobal ActionViewsPersonalSetting(ffr__ActionViewsPersonalSetting__c sObj, List<ffr.ActionViewsService.ActionViewsSetting> settingsList) Creates an API version of an empty online inquiries personal setting object. Input Parameters
Return ValueThis constructor does not return a value. createSObjectglobal ffr__ActionViewsPersonalSetting__c createSObject(String settingResult) Creates an SObject version of the online inquiry personal setting instance from its API version. Input Parameters
Return ValueThis service returns an ActionViewsPersonalSetting__c object. ffr.ActionViewsService.ActionViewsSettingglobal class ActionViewsSetting Holds a key-value pair storing a personal setting that has been saved by a user choosing Remember My Settings from within Online Inquiries. Properties
ffr.ActionViewsService.ActionResultglobal class ActionResult The result of running an action within Online Inquiries. Properties
ffr.ActionViewsService.ValidationResultglobal class ValidationResult The result (success or failure) of validating an action within Online Inquiries. Properties
|