Accounting

c2g.CODAAPISelector_3_0

global with sharing class CODAAPISelector_3_0

The service class relating to Selection Definitions.

Properties

Name Type Description
VERSION_STRING String The API version.
SERVICE_NAME String The name of the service.
m_mapFieldsHD Map<String, Schema.SObjectField>
m_mapFieldsLI Map<String, Schema.SObjectField>
m_mapGlobalDescribe Map<String, Schema.SObjectType>

Methods

GetAPIVersion

webservice static String GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

webservice static String GetServiceName()

Used to get the name of the service.

Return Value

Text

CreateSelection

webservice static void CreateSelection(c2g.CODAAPICommon_3_0.Context context, c2g.CODASelectionWebService.Selection selection, String name, boolean overrideExisting)

This service allows you to define selection criteria for sending mass email and retrieving FinancialForce documents and transactions via Microsoft Excel. See the FinancialForce XL Help for more information.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_3_0.Context Identifies the FinancialForce company in which the current operation executes.
selection c2g.CODASelectionWebService.Selection Holds the selection definition you want to create.
name String The name of an existing selection definition that you want to override. Leave this blank if you do not want to override an existing selection definition.
overrideExisting boolean Set to true if you want this selection definition to override the existing definition identified by the 'name' parameter.

Return Value

This web service does not return a value.

GetSelection

webservice static c2g.CODASelectionWebService.Selection GetSelection(c2g.CODAAPICommon_3_0.Context context, String name)

This service allows you to retrieve a selection definition.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_3_0.Context Identifies the FinancialForce company in which the current operation executes.
name String Identifies the selection definition you want to retrieve.

Return Value

This web service returns a CODASelectionWebService.Selection object.

GetSelectionsByUser

webservice static List<String> GetSelectionsByUser(c2g.CODAAPICommon_3_0.Context context, String objectUser, c2g.CODASelectionWebService.enumObject headerObject)

This service allows you to retrieve selection definitions by user or object type.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_3_0.Context Identifies the FinancialForce company in which the current operation executes.
objectUser String The user you are interested in.
headerObject c2g.CODASelectionWebService.enumObject The object type you are interested in.

Return Value

This web service returns a list of String objects.

GetData

webservice static c2g.CODAAPISelectorTypes_3_0.DataSet GetData(c2g.CODAAPICommon_3_0.Context context, c2g.CODASelectionWebService.Selection selection, Integer maxRecords)

This service allows you to retrieve data using a specified selection definition.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_3_0.Context Identifies the FinancialForce company in which the current operation executes.
selection c2g.CODASelectionWebService.Selection The selection definition you want to use to retrieve the data.
maxRecords Integer The maximum number of records to retrieve.

Return Value

This web service returns a c2g.CODAAPISelectorTypes_3_0.DataSet object.

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