Reporting API Documentation

ffr.RelatedContentPaneService

global with sharing class RelatedContentPaneService

Methods

load

global static List<ffr.RelatedContentPaneService.Pane> load(Set<Id> relatedContentPaneIds)

save

global static List<ffr.RelatedContentPaneService.Pane> save(List<ffr.RelatedContentPaneService.Pane> relatedContentPaneDTOs)

getComponents

global static List<ffr.RelatedContentPaneService.Component> getComponents(Set<Id> componentIds)

getRcpIdentities

global static List<ffr.RelatedContentPaneService.RCPSummary> getRcpIdentities()

getRcpData

global static ffr.RelatedContentPaneService.RcpData getRcpData(Id rcpId, Id dataId)

Fetches the data to populate a Related Content Pane.

Input Parameters

Name Type Description
rcpId Id Identifies the RCP to populate.
dataId Id Identifies the data to be fetched (the id of the driving entity).

Return Value

This service returns a ffr.RelatedContentPaneService.RcpData object.

saveRcpData

global static ffr.RelatedContentPaneService.SaveRcpDataResponse saveRcpData(ffr.RelatedContentPaneService.SaveRcpDataRequest request)

Save updates from the RCP. Performs access checking before performing the save.

rcpPaletteCommand

global static Object rcpPaletteCommand(ffr.RelatedContentPaneService.RcpPaletteCommandRequest request)

rcpServerCommand

global static Object rcpServerCommand(ffr.RelatedContentPaneService.RcpServerCommandRequest request)

ffr.RelatedContentPaneService.SaveRcpDataRequest

global class SaveRcpDataRequest

Properties

Name Type Description
RcpId Id
Records List<ffr.RelatedContentPaneService.SaveRecordRequest>

ffr.RelatedContentPaneService.Pane

global class Pane

Properties

Name Type Description
Id Id
Name String
LastModifiedDate Datetime
PaneWidth String
DrivingEntity String
DrivingEntityLabel String
Tabs List<ffr.RelatedContentPaneService.Tab>
TemplateNamesInUse List<String>

Methods

Pane

global Pane()

Pane

global Pane(ffr__RelatedContentPane__c sObj)

createSObject

global ffr__RelatedContentPane__c createSObject()

ffr.RelatedContentPaneService.RCPSummary

global class RCPSummary

Properties

Name Type Description
Id Id
Name String
DrivingEntity String

Methods

RCPSummary

global RCPSummary(Id theId, String theName, String theDrivingEntity)

ffr.RelatedContentPaneService.Tab

global class Tab

Properties

Name Type Description
Id Id
Name String
Components List<ffr.RelatedContentPaneService.Component>

Methods

Tab

global Tab()

Tab

global Tab(ffr__RelatedContentPaneTab__c sObj)

createSObject

global ffr__RelatedContentPaneTab__c createSObject()

ffr.RelatedContentPaneService.Component

global class Component

Properties

Name Type Description
Id Id
ApexClass String
RuntimeClass String
Config String
Height Integer
Width Integer

Methods

Component

global Component()

Component

global Component(ffr__RelatedContentPaneComponent__c sObj)

Component

global Component(ffr__RelatedContentPaneComponent__c sObj, String runtimeClass)

createSObject

global ffr__RelatedContentPaneComponent__c createSObject()

ffr.RelatedContentPaneService.SaveRcpDataResponse

global class SaveRcpDataResponse

Place-holder response class to allow addition of data in future versions.

ffr.RelatedContentPaneService.SaveRecordRequest

global class SaveRecordRequest

Properties

Name Type Description
Id Id
Values Map<String, Object>
Path String[]

Methods

getSObjectType

global SObjectType getSObjectType()

getAffectedFields

global Set<SObjectField> getAffectedFields()

constructRecord

global SObject constructRecord()

ffr.RelatedContentPaneService.RcpData

global class RcpData

Properties

Name Type Description
Rcp ffr.RelatedContentPaneService.Pane
Data SObject

ffr.RelatedContentPaneService.RcpPaletteCommandRequest

global class RcpPaletteCommandRequest

Request to perform an action on behalf of an RCP Config Component.

Properties

Name Type Description
apexClass String The class of the server-side component
drivingEntity String The Name of the driving object
command String Command string sent by client
arg String Argument object sent by client

ffr.RelatedContentPaneService.RcpServerCommandRequest

global class RcpServerCommandRequest

Request to perform an action on behalf of an RCP Client Component.

Properties

Name Type Description
rcpId Id The ID of the RCP
apexClass String The class of the server-side component
componentId Id The ID of the component within the RCP definition
dataId Id ID of the driving object
command String Command string sent by client
arg String Argument object sent by client, JSON encoded
© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.