Java API Cheatsheet

These APIs are defined in the Functions class.

Record Handling

Syntax	Description	Return	Category
addRecord(String objectName, Params params)	Adds a new record of type objectId with values from params	Result object	Record Handling
updateRecord(String objectName, String recordId, Params params)	Updates record of type objectId with values params. The Record is identified by recordId	Result object	Record Handling
changeOwnerShipInfo(String object_id, String record_id, String owner_id)	Changes the owner of the designated record	None	Record Handling
deleteRecord(String objectName, String recordId)	Deletes Record of type objectId where id is recordId	Result object	Record Handling
getRecord(String objectName, String fields, String recordId)	Gets the record of type objectId identified by recordId. fields is a comma separated list of fields that you want to fetch	Result object	Record Handling
getRecordCount(String objectName, String criteria)	Returns the number of records in the object	int	Record Handling
searchRecords(String objectName, String fields, String criteria [, Parameters params])	Search and retrieve the records for an object. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression	Result object	Record Handling
searchRecords(String objectName, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])	Search and retrieve records for an object. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression	Result object	Record Handling
execSQL(String query)	Execute a SQL query	Result object	Record Handling
getRecord(String compositeObject, String fields, String recordId)	Get a [{Composite Object]] record, with specified fields.	Result object	Composite Objects
getRecordCount(String compositeObject, String criteria)	Gets a count of records in a Composite Object that match specified filtering criteria.	int	Composite Objects
searchRecords(String compositeObject, String fields, String criteria [, Parameters params])	Search and retrieve Composite Object records. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression	Result object	Composite Objects
searchRecords(String compositeObject, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])	Search and retrieve Composite Object records. fields is a comma-separated list of fields to fetch. criteria is a Filter Expression	Result object	Composite Objects

Email and Document Management

Email and Document Management

Syntax	Description	Return
sendEmail(String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList)	Sends an Email	Result object
sendEmailUsingTemplate(String objectName, String recordId, String to, String cc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)	Sends an Email evaluating Template identified by bodyTemplateId as email body	Result object
generateDocument(String objectName, String recordId, String templateId, String format)	Generates document of templateId evaluated with params in format. If format is "PDF" it generates the document in PDF format, otherwise HTML format. It relates this generated document to object of type objectId and record with id recordId	Result object

Transaction Management

Utility functions

Syntax	Description	Return
addSavePoint(String name)	Adds a Save Point with name	None
doesSavePointExist(String name)	checks whether the named save point exists or not	Boolean
getAllSavePoints()	Returns All Save Points	Set
rollback()	Roll backs all the inserts and updates	None
rollbackToSavePoint(String name)	Rollback to specific save point with name	None
removeSavePoint(String name)	removes save point with name from save point list	None

Localization Functions

Functions class (static methods):

Syntax	Description	Return
formatCurrency(String value, int precision)	Format a value specified in Database Format with no currency character and no grouping indicators (commas), and with a decimal point for fractional amounts.	Return a String with the value formatted using the company's locale setting for currencies, with the number of decimal places specified for the precision. If the conversion fails, return the original string.
formatNumber(String value, int precision)	Format a value specified in Database Format with no grouping indicators (commas), with a decimal point for fractional amounts.	Return a String with the value formatted using the user's locale, with the number of decimal places specified for the precision. If the conversion fails, return the original string.
formatPercent(String value, int precision)	Format a value specified in Database Format with no percent sign, no grouping indicators (commas), and with a decimal point for fractional amounts.	Return a String with the value formatted using the user's locale, with the number of decimal places specified for the precision. If the conversion fails, return the original string.
parseCurrency(String value)	Parse a currency amount in the format specified by the company's locale setting for currencies.	Return a String in Database Format format. If parsing fails, return the original string.
parseNumber(String value)	Parse a numeric amount (with or without a fractional amount) in the format specified by the user's locale.	Return a String in Database Format format. If parsing fails, return the original string.
parsePercent(String value)	Parse a percentage in the format specified by the user's locale.	Return a String in Database Format format. If parsing fails, return the original string.
validateCurrency(String value)	Verify that the currency amount is in the format specified by the company's locale setting for currencies.	Return true if the data is in the expected format, otherwise false.
validateNumber(String value)	Verify that the numeric amount (with or without a fractional amount) is in the format specified by the user's locale.	Return true if the data is in the expected format, otherwise false.
validatePercent(String value)	Verify that the percentage is in the format specified by the user's locale.	Return true if the data is in the expected format, otherwise false.

Additional Utility Functions

Static Utility functions in the Functions class:

Syntax	Description	Return
getEnv(String key)	Gets the environment variable value for the key	The value of the environment variable
getParametersInstance()	Gets an instance of Parameters class	Parameters object
setTargetPage(String url)	Sets the target page	None
showMessage(long millisecs)	Displays message	None
sleep(String message)	Sleeps for the designated number of milliseconds.	None
throwError(String message)	Throws error with the message	None

ServiceConfiguration class (static methods):

Syntax	Return Type	Description
getServiceName();	String	Returns the Service Name (e.g. company name)
getServiceDomainURL();	String	Returns the Service URL.

Metadata Management

Customization methods.

Learn more: Java_API:Customize

Syntax	Description	Return
getObjectMetaData(String objectName)	Retrieve metadata from a Custom Objects.	CustomObjectMetaDataBean
getObjectMetaDataMap()	Return a map of all visible Custom Object object metadata records, indexed by object ID.	Map: Object ID => CustomObjectMetaDataBean
addObjectMetaData(CustomObjectMetaDataBean)	Create a new object.	String:Object ID
updateObjectMetaData(CustomObjectMetaDataBean)	Modify an object definition.	String: Object ID
deleteObjectMetaData(CustomObjectMetaDataBean)	Deletes an object	None
getRecordLocator(String objectName)	Get an object's Record Locator information.	RecordLocatorBean
updateRecordLocator(RecordLocatorBean)	Modify an object's Record Locator Settings.	String:Object ID