c2g.CODAAPIPrintFormat_3_0

global with sharing class CODAAPIPrintFormat_3_0

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

the service class relating to print formats. these are used by the print formatter tool.

Properties

Name	Type	Description
VERSION_STRING	String	the api version.
SERVICE_NAME	String	the name of the service.

Methods

webService static String GetAPIVersion()
webService static String GetServiceName()
webService static List<String> GetPrintFormatsByUser(c2g.CODAAPICommon_3_0.Context context, String objectUser, String templateType)
webService static c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat GetPrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPICommon.Reference value)
webService static void DeletePrintFormat(c2g.CODAAPICommon_3_0.Context context, String name)
webService static c2g.CODAAPICommon.Reference CreatePrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat value, String name)
webService static c2g.CODAAPICommon.Reference UpdatePrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat value, String name, Boolean overrideExisting)

GetAPIVersion

Deprecated: Deprecated: The class has been marked as deprecated so this method will not be available in the future.

webService static String GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

Deprecated: Deprecated: The class has been marked as deprecated so this method will not be available in the future.

webService static String GetServiceName()

Used to get the name of the service.

Return Value

Text

GetPrintFormatsByUser

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static List<String> GetPrintFormatsByUser(c2g.CODAAPICommon_3_0.Context context, String objectUser, String templateType)

This service allows you to retrieve print formats by user or template 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.
templateType	String	The template type you are interested in.

Return Value

This web service returns a list of String objects.

GetPrintFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat GetPrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a print format.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_3_0.Context	Identifies the FinancialForce company in which the current operation executes.
value	c2g.CODAAPICommon.Reference	Identifies the print format you want to retrieve.

Return Value

This web service returns a c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat object.

DeletePrintFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static void DeletePrintFormat(c2g.CODAAPICommon_3_0.Context context, String name)

This service allows you to delete a print format. Use ManagePrintFormatter (Manage Print Formatter) custom permission to grant permissions on this method.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_3_0.Context	Identifies the FinancialForce company in which the current operation executes.
name	String	The name of the print format you want to delete.

Return Value

This web service does not return a value.

CreatePrintFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference CreatePrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat value, String name)

This service allows you to create a print format for use with Print Formatter. See the Property Reference section in the FinancialForce Print Formatter Help for more information. Use ManagePrintFormatter (Manage Print Formatter) custom permission to grant permissions on this method.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_3_0.Context	Identifies the FinancialForce company in which the current operation executes.
value	c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat	Holds details of the print format you want to create.
name	String	This parameter can be ignored; it is not used.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpdatePrintFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference UpdatePrintFormat(c2g.CODAAPICommon_3_0.Context context, c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat value, String name, Boolean overrideExisting)

This service allows you to update a print format for use with Print Formatter. Use ManagePrintFormatter (Manage Print Formatter) custom permission to grant permissions on this method.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_3_0.Context	Identifies the FinancialForce company in which the current operation executes.
value	c2g.CODAAPIPrintFormatTypes_3_0.PrintFormat	Holds details of the print format you want to update.
name	String	The name of an existing print format that you want to override. Leave this blank if you do not want to override an existing print format.
overrideExisting	Boolean	Set to true if you want this print format to override the existing format identified by the 'name' parameter.

Return Value

This web service returns a CODAAPICommon.Reference object.