Reporting API Documentation

ffr.RelatedContentPaneComponentBase

global abstract class RelatedContentPaneComponentBase

Base class for a Related Content Pane Component

Date

2016

Properties

Name Type Description
MAX_LABEL_LENGTH Integer The max label length of a Related Content Pane Component
MAX_LOOKUPS Integer The maximum number of lookups in a field path

Methods

requiredPicklistFields

global virtual Map<SObjectType, Set<SObjectField>> requiredPicklistFields()

Gets any required picklist fields for the component

addDependentComponents

global virtual void addDependentComponents(Map<String, ApexPages.Component> dependentComponentMap)

getDependencies

global virtual Map<Schema.SObjectType, List<String>> getDependencies(String config)

A method to get a map of dependancies of a component. This is keyed by sObject type of any dependancies

Input Parameters

Name Type Description
config String The config json string

createPaletteComponent

global abstract ffr.RelatedContentPaneComponentBase.PaletteComponent createPaletteComponent(Schema.DescribeSObjectResult drivingEntity)

A base method to return the pallette component for the given driving entity. Return null if not supported.

Input Parameters

Name Type Description
drivingEntity Schema.DescribeSObjectResult The SObject describe result of the driving entity

createRuntimeComponent

global abstract ffr.RelatedContentPaneComponentBase.RuntimeComponent createRuntimeComponent(Schema.DescribeSObjectResult drivingEntity, String configJson)

A base method to return the component instance for the given driving entity and configuration.

Input Parameters

Name Type Description
drivingEntity Schema.DescribeSObjectResult The SObject describe result of the driving entity
configJson String The config json string

requiredLabels

global abstract Map<String, String> requiredLabels()

Gets any required labels for the component

requiredIFrameResources

global virtual Map<String, String> requiredIFrameResources()

Gets any required IFrame resources for the component

getApexClass

global abstract String getApexClass()

A base method to get the name of the components apex class

ffr.RelatedContentPaneComponentBase.ObjectReference

global class ObjectReference

Holds a reference to a salesforce object.

Properties

Name Type Description
objectDescribe Schema.DescribeSObjectResult Holds SObject describe result
fields Set<Schema.SObjectField> A set of the objects fields
lookups Map<Schema.SObjectField, ffr.RelatedContentPaneComponentBase.ObjectReference> A map of lookup fields to their object reference
subQueries Map<Schema.ChildRelationship, ffr.RelatedContentPaneComponentBase.ObjectReference> A map of a child relationships to their object reference

Methods

ObjectReference

global ObjectReference(Schema.SObjectType objectType)

Creates an API version of an object reference object using the specified parameters.

Input Parameters

Name Type Description
objectType Schema.SObjectType The SObject type.

addField

global void addField(Schema.SObjectField field)

Adds a field to the objects set of fields

Input Parameters

Name Type Description
field Schema.SObjectField The SObject field

lookup

global ffr.RelatedContentPaneComponentBase.ObjectReference lookup(Schema.SObjectField lookupField)

Gets the object reference from a lookup field

Input Parameters

Name Type Description
lookupField Schema.SObjectField The SObject lookup field

subQuery

global ffr.RelatedContentPaneComponentBase.ObjectReference subQuery(Schema.ChildRelationship relationship)

Gets the object reference from a child relationship

Input Parameters

Name Type Description
relationship Schema.ChildRelationship The child relationship.

buildQuery

global String buildQuery(String whereClause)

Builds a query for the object

Input Parameters

Name Type Description
whereClause String A where clause for the query

getFieldMap

global Map<String, Schema.SobjectField> getFieldMap()

Get a map of the objects fields

ffr.RelatedContentPaneComponentBase.IPaletteCommandHandler

global interface IPaletteCommandHandler

An interface for a palette command handler

Methods

getArgumentType

Type getArgumentType()

run

Object run(Schema.DescribeSObjectResult drivingEntity, Object arg)

ffr.RelatedContentPaneComponentBase.ICommandHandler

global interface ICommandHandler

An interface for a command handler

Methods

getArgumentType

Type getArgumentType()

Returns the class type that describes the third parameter of the run method. This is used for deserialising the generic object.

run

Object run(Id drivingId, Object config, Object arg)

Performs the runtime command. Because of the limitations of Salesforce's reflection, we can only generically create instances of classes, not methods.

Input Parameters

Name Type Description
drivingId Id The ID of the instance of the driving object.
config Object The Config of the instance of component.
arg Object An argument object whose class type is defined by the 'getArgumentType' method.

ffr.RelatedContentPaneComponentBase.PaletteComponent

global abstract class PaletteComponent

A base for a palette component

Properties

Name Type Description
m_drivingEntity Schema.DescribeSObjectResult the SObject describe result of the driving entity

Methods

PaletteComponent

global PaletteComponent(Schema.DescribeSObjectResult drivingEntity)

Creates an API version of a palette component using the specified parameters.

Input Parameters

Name Type Description
drivingEntity Schema.DescribeSObjectResult The SObject describe result of the driving entity

getTitle

global abstract String getTitle()

A base method to get the title of the component

getRuntimeComponentClass

global abstract String getRuntimeComponentClass()

A base method to get the runtime component class of the component

getConfigDialogClass

global virtual String getConfigDialogClass()

Get the config dialog class of the component

getMinSize

global abstract ffr.CommonService.Size getMinSize()

A base method to get the minimum size of the component

getMaxSize

global abstract ffr.CommonService.Size getMaxSize()

A base method to get the maximum size of the component

getApexClass

global abstract String getApexClass()

A base method to get the apex class name for the component

validateConfig

global abstract void validateConfig(ffr.RelatedContentPaneService.Component rcpCompDTO)

A base method to validate the config for a related content pane component

Input Parameters

Name Type Description
rcpCompDTO ffr.RelatedContentPaneService.Component A related content pane component

performPaletteCall

global virtual Object performPaletteCall(String command, String argJSON)

Perform a request on behalf of the client.

getParams

global virtual Map<String, Object> getParams()

Get the params needed by the component

ffr.RelatedContentPaneComponentBase.RuntimeComponent

global abstract class RuntimeComponent

A base for a runtime component

Properties

Name Type Description
m_drivingEntity Schema.DescribeSObjectResult The SObject describe result of the driving entity
m_config Object The config of the component

Methods

RuntimeComponent

global RuntimeComponent(Schema.DescribeSObjectResult drivingEntity, Object config)

Creates an API version of a runtime component using the specified parameters.

Input Parameters

Name Type Description
drivingEntity Schema.DescribeSObjectResult The SObject describe result of the driving entity
config Object The config of the component

getQueryRequirements

global virtual void getQueryRequirements(ffr.RelatedContentPaneComponentBase.ObjectReference drivingEntityRef)

Get the query requirements for a component

Input Parameters

Name Type Description
drivingEntityRef ffr.RelatedContentPaneComponentBase.ObjectReference The SObject describe result of the driving entity

getExtraData

global virtual void getExtraData(Id dataId, SObject dataRow, Map<String, Object> extraData)

Gets any extra data needed for a component

getApexClass

global abstract String getApexClass()

A base method to get the apex class name of a component

performServerCall

global virtual Object performServerCall(Id drivingId, String command, String argJSON)

Perform a request on behalf of the client.

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