Difference between revisions of "Java API Cheatsheet"

Latest revision as of 09:38, 26 September 2016

These APIs are defined in the Functions class.

Record Handling

Standard Objects

Syntax	Description	Return
`addRecord(String objectName, Params params)`	Adds a new record of type objectId with values from params	Result object
`updateRecord(String objectName, String recordId, Params params)`	Updates record of type objectId with values params. The Record is identified by recordId	Result object
`changeOwnerShipInfo(String object_id, String record_id, String owner_id)`	Changes the owner of the designated record	None
`deleteRecord(String objectName, String recordId)`	Deletes Record of type objectId where id is recordId	Result object
`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
`getRecordCount(String objectName, String criteria)`	Returns the number of records in the object	int
`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
`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
`execSQL(String query)`	Execute a SQL query	Result object

Composite Objects

Composite Object APIs

Syntax	Description	Return
`getRecord(String compositeObject, String fields, String recordId)`	Get a Composite Object record, with specified fields.	Result object
`getRecordCount(String compositeObject, String criteria)`	Gets a count of records in a Composite Object that match specified filtering criteria.	int
`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
`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

Email

Java API:Email

Syntax	Description	Return
`sendEmail(String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList)`	Send an email	Result object
`sendEmail(String objectName, String id, String to, String cc, String bcc, String subject, String body, String attachmentTemplateId, String attachmentIdList)`	Send an email with a bcc list	Result object
`sendEmail(String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList, TenantContext context)`	Send an email with tenant context	Result object
`sendEmail(String objectName, String recordid, String to, String cc, String bcc, String subject, String body, String attachmentTemplateId, String attachmentIdList, String fromName, String fromAddress)`	Send an email with bcc list, from name, and from address	Result object
`sendEmailUsingTemplate(String objectName, String recordId, String to, String cc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)`	Send an email evaluating Template identified by bodyTemplateId as email body	Result object
`sendEmailUsingTemplate(String objectName, String recordId, String to, String cc, String bcc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)`	Send an email using Template with bcc list	Result object
`sendEmailUsingTemplate(String objectName, String recordId, String to, String cc, String bcc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList, String fromName, String fromAddress)`	Send an email using Template with bcc list, from name, and from address	Result object

Document Management

Java API:Document Management

Syntax	Description	Return
`generateDocument(String objectName, String recordId, String templateId, String format)`	Generates document of using the specified template, in the specified format (PDF or HTML), using the specified object and record to populate template variables. Returns the ID of the generated document in the Result object.	Result
`getDocument(String documentId)`	Gets a document identified by its ID, in the form of a PlatformFileBean contained in the Result.	Result
Example: Generate an Attachment	Shows how to generate a document and attach it to the current record.

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

Logger Functions

Logger class (static methods):

Syntax	Description
`info(String msg, String msgType)`	Log an information message. This is the default display level in the Debug Log. This level is appropriate for most application debugging.
`warn(String msg, String msgType)`	Log a warning.
`error(String msg, String msgType)`	Log an error message.
`fatal(String msg, String msgType)`	Log a fatal error.

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.
`formatDate(Date d)`	Format a date/time value.	Return a String with the date formatted according the user's settings.
`formatDateTime(Date d)`	Format a date/time value.	Return a String with the date formatted according the user's settings, and time formatted using the user's locale.
`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.
`formatTime(Date d)`	Format a time value.	Return a String with the time formatted using the user's locale.
`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`.

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(String message)`	Displays message	None
`sleep(long millisecs)`	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

Search

where to start

Feedback

customize and design

resources

Tools

Personal tools

Difference between revisions of "Java API Cheatsheet"

Latest revision as of 09:38, 26 September 2016

Contents

Record Handling

Standard Objects

Composite Objects

Email

Document Management

Transaction Management

Logger Functions

Localization Functions

Utility Functions

Metadata Management

@@ Line 1: / Line 1: @@
 These APIs are defined in the [http://lj.platformatyourservice.com/lj80/download/javadocs/com/platform/api/Functions.html Functions] class.
+__TOC__
+=== Record Handling ===
+====Standard Objects====
+[[Java_API:Record_Handling|Record Handling APIs]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+|-width="150"
+|<tt>[[Java API:Record_Handling#addRecord|addRecord]](String objectName, Params params)</tt>||Adds a new record of type objectId with values from params|| [[Result Class|Result object]]
+|-
+|<tt>[[Java_API:Record_Handling#updateRecord|updateRecord]](String objectName, String recordId, Params params)</tt>||Updates record of type objectId with values params. The Record is identified by recordId|| [[Result Class|Result object]]
+|-
+|<tt>[[Java_API:Record_Handling#changeOwnerShipInfo|changeOwnerShipInfo]](String object_id, String record_id, String owner_id)</tt>||Changes the owner of the designated record|| None
+|-
+|<tt>[[Java API:Record_Handling#deleteRecord |deleteRecord]](String objectName, String recordId)</tt>||Deletes Record of type objectId where id is recordId|| [[Result Class|Result object]]
-{| border="1" cellpadding="5" cellspacing="0"
+|-
+|<tt>[[Java API:Record_Handling#getRecord|getRecord]](String objectName, String fields, String recordId)</tt>||Gets the record of type objectId identified by recordId. fields is a comma separated list of fields that you want to fetch|| [[Result Class|Result object]]
+|-
+|<tt>[[Java API:Record_Handling#getRecordCount|getRecordCount]](String objectName, String criteria)</tt>|| Returns the number of records in the object || int
+|-
+|<tt>[[Java_API:Record_Handling#searchRecords|searchRecords]](String objectName, String fields, String criteria [, Parameters params])</tt>||Search and retrieve the records for an object. <tt>fields</tt> is a comma-separated list of fields to fetch. <tt>criteria</tt> is a [[JAVA API:Filter Expressions in JAVA APIs|Filter Expression]] || [[Result Class|Result object]]
+|-
+|<tt>[[Java_API:Record_Handling#searchRecords|searchRecords]](String objectName, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])</tt>||Search and retrieve records for an object. <tt>fields</tt> is a comma-separated list of fields to fetch. <tt>criteria</tt> is a [[JAVA API:Filter Expressions in JAVA APIs|Filter Expression]] || [[Result Class|Result object]]
+|-
+|<tt>[[Java_API:Record_Handling#execSQL |execSQL]](String query)</tt>||Execute a SQL query|| [[Result Class|Result object]]
+|}
+====Composite Objects====
+[[Java_API:Composite_Objects|Composite Object APIs]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+|-
+|<tt>[[Java API:Composite_Objects#getRecord|getRecord]](String compositeObject, String fields, String recordId)</tt>||Get a [[Composite Object]] record, with specified fields. || [[Result Class|Result object]]
+|-
+|<tt>[[Java API:Composite_Objects#getRecordCount|getRecordCount]](String compositeObject, String criteria)</tt>|| Gets a count of records in a [[Composite Object]] that match specified filtering criteria. || int
+|-
+|<tt>[[Java_API:Composite_Objects#searchRecords|searchRecords]](String compositeObject, String fields, String criteria [, Parameters params])</tt>||Search and retrieve [[Composite Object]] records. <tt>fields</tt> is a comma-separated list of fields to fetch. <tt>criteria</tt> is a [[JAVA API:Filter Expressions in JAVA APIs|Filter Expression]] || [[Result Class|Result object]]
+|-
+|<tt>[[Java_API:Composite_Objects#searchRecords|searchRecords]](String compositeObject, String fields, String criteria, String sortBy, String sortOrder, String sortBy2, String sortOrder2, int offset, int numberOfRows [, Parameters params])</tt>||Search and retrieve [[Composite Object]] records. <tt>fields</tt> is a comma-separated list of fields to fetch. <tt>criteria</tt> is a [[JAVA API:Filter Expressions in JAVA APIs|Filter Expression]] || [[Result Class|Result object]]
+|}
+<!--
+=== Tenant Data Sharing ===
+:{| border="1" cellpadding="5" cellspacing="0"
 !Syntax
 !Description
 !Return
 !Category
-!API Detail
 |-width="150"
-|<tt>addEvent (String subject, String ownerID, Date startDate, int hour, int min, int duration [, Parameters params])</tt>||Adds an event with values from params|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#addEvent|<tt>addEvent</tt>]]
+|<tt>signature</tt>|| descr || [[Result Class|Result object]] || category
+|}
+=== Data Import ===
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+!Category
+|-width="150"
+|<tt>signature</tt>|| descr || [[Result Class|Result object]] || category
+|}
+-->
+=== Email ===
+[[Java API:Email]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+|-width="150"
+| <tt>[[Java API:Email#sendEmail |sendEmail]](String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList)</tt>
+| Send an email
+| [[Result Class|Result object]]
+|-width="150"
+| <tt>[[Java API:Email#sendEmail |sendEmail]](String objectName, String id, String to, String cc, String bcc, String subject, String body, String attachmentTemplateId, String attachmentIdList)</tt>
+| Send an email with a bcc list
+| [[Result Class|Result object]]
+|-width="150"
+| <tt>[[Java API:Email#sendEmail |sendEmail]](String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList, TenantContext context)</tt>
+| Send an email with tenant context
+| [[Result Class|Result object]]
+|-width="150"
+| <tt>[[Java API:Email#sendEmail |sendEmail]](String objectName, String recordid, String to, String cc, String bcc, String subject, String body, String attachmentTemplateId, String attachmentIdList, String fromName, String fromAddress)</tt>
+| Send an email with bcc list, from name, and from address
+| [[Result Class|Result object]]
 |-
-|<tt>addRecord (String objectName, Params params)</tt>||Adds a new record of type objectId with values from params|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java API:Record_Handling#addRecord|<tt>addRecord</tt>]]
+| <tt>[[Java_API:Email#sendEmailUsingTemplate|sendEmailUsingTemplate]](String objectName, String recordId, String to, String cc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)</tt>
+| Send an email evaluating Template identified by bodyTemplateId as email body
+| [[Result Class|Result object]]
 |-
-|<tt>addSavePoint (String name)</tt>||Adds a Save Point with name|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#addSavePoint |<tt> addSavePoint </tt>]]
+| <tt>[[Java_API:Email#sendEmailUsingTemplate|sendEmailUsingTemplate]](String objectName, String recordId, String to, String cc, String bcc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)</tt>
+| Send an email using Template with bcc list
+| [[Result Class|Result object]]
 |-
-|<tt>addTask (String subject, Date dueDate, String ownerId [, Parameters params])</tt>||Adds a task with values from params|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#addTask|<tt>addTask</tt>]]
+| <tt>[[Java_API:Email#sendEmailUsingTemplate|sendEmailUsingTemplate]](String objectName, String recordId, String to, String cc, String bcc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList, String fromName, String fromAddress)</tt>
+| Send an email using Template with bcc list, from name, and from address
+| [[Result Class|Result object]]
+|}
+=== Document Management ===
+[[Java API:Document Management]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
 |-
-|<tt>changeOwnerShipInfo(String object_id, String record_id, String owner_id)</tt>||Changes the owner of the designated record|| None|| [[Java_API:Record_Handling|Record Handling]] || [[Java_API:Record_Handling#changeOwnerShipInfo|changeOwnerShipInfo]]
+| <tt>[[Java API:Document Management#generateDocument |generateDocument]](String objectName, String recordId, String templateId, String format)</tt>
+| Generates document of using the specified template, in the specified format (PDF or HTML), using the specified object and record to populate template variables. Returns the ID of the generated document in the Result object.
+| [[Result Class|Result]]
 |-
-|<tt>debug (Object obj)</tt>||Puts a debug statement into the debug log for Object obj. obj can be a String also|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#debug |<tt> debug </tt>]]
+| <tt>[[Java API:Document Management#getDocument |getDocument]](String documentId)</tt>
+| Gets a document identified by its ID, in the form of a {{^PlatformFileBean}} contained in the Result.
+| [[Result Class|Result]]
 |-
-|<tt>deleteEvent (String eventId)</tt>||Deletes the event for the eventId|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#deleteEvent | <tt> deleteEvent </tt>]]
+| [[Java API:Document Management#Example:_Generate_an_Attachment|Example: Generate an Attachment]]
+| colspan="2"| Shows how to generate a document and attach it to the current record.
+|}
+=== Transaction Management ===
+[[Java_API:Utility functions|Utility functions]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+|-width="150"
+|<tt>[[Java_API:Utility functions#addSavePoint |addSavePoint]](String name)</tt>||Adds a Save Point with name|| None
+|-
+|<tt>[[Java API:Utility functions#doesSavePointExist |doesSavePointExist]](String name)</tt>||checks whether the named save point exists or not|| Boolean
+|-
+|<tt>[[Java_API:Utility functions#getAllSavePoints|getAllSavePoints]]()</tt>||Returns All Save Points|| Set
+|-
+|<tt>[[Java_API:Utility functions#rollback |rollback]]()</tt>||Roll backs all the inserts and updates|| None
+|-
+|<tt>[[Java_API:Utility functions#rollbackToSavePoint|rollbackToSavePoint]](String name)</tt>||Rollback to specific save point with name|| None
+|-
+|<tt>[[Java_API:Utility functions#removeSavePoint|removeSavePoint]](String name)</tt>||removes save point with name from save point list|| None
+|}
+=== Logger Functions ===
+[{{DOCHOST}}/javadocs/com/platform/api/Logger.html Logger] class (static methods):
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+|-
+| <tt>[[Java API:Utility functions#Logger Functions|info]](String msg, String msgType)</tt>
+| Log an information message. This is the default display level in the [[Debug Log]].<br>This level is appropriate for most application debugging.
 |-
-|<tt>deleteRecord (String objectName, String recordId)</tt>||Deletes Record of type objectId where id is recordId|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java API:Record_Handling#deleteRecord |<tt> deleteRecord </tt>]]
+| <tt>[[Java API:Utility functions#Logger Functions|warn]](String msg, String msgType)</tt>
+| Log a warning.
 |-
-|<tt>deleteTask (String recordId)</tt>||Deletes a task for the taskId|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#deleteTask |<tt> deleteTask</tt>]]
+| <tt>[[Java API:Utility functions#Logger Functions|error]](String&nbsp;msg,&nbsp;String&nbsp;msgType)</tt>
+| Log an error message.
 |-
-|<tt>doesSavePointExist (String name)</tt>||checks whether specified save point with name is exist or not|| Boolean|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#doesSavePointExist |<tt> doesSavePointExist </tt>]]
+| <tt>[[Java API:Utility functions#Logger Functions|fatal]](String msg, String msgType)</tt>
+| Log a fatal error.
+|}
+=== Localization Functions ===
+[{{DOCHOST}}/javadocs/com/platform/api/Functions.html Functions] class (static methods):
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
 |-
-|<tt>exec (String functionName, Parameters params)</tt>||Executes function functionName with params as input. Note that this params object is visible in functionName as functionParams|| The return value is defined by the function|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#exec |<tt> exec </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatCurrency(java.lang.String,%20int) <tt>formatCurrency(String value, int precision)</tt>]
+| 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 <tt>precision</tt>. If the conversion fails, return the original string.
+|-
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatDate(java.util.Date) <tt>formatDate(Date d)</tt>]
+| Format a date/time value.
+| Return a String with the date formatted according the user's settings.
+|-
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatDateTime(java.util.Date) <tt>formatDateTime(Date d)</tt>]
+| Format a date/time value.
+| Return a String with the date formatted according the user's settings, and time formatted using the user's locale.
+|-
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatNumber(java.lang.String,%20int) <tt>formatNumber(String value, int precision)</tt>]
+| 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 <tt>precision</tt>. If the conversion fails, return the original string.
+|-
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatPercent(java.lang.String,%20int) <tt>formatPercent(String value, int precision)</tt>]
+| 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 <tt>precision</tt>. If the conversion fails, return the original string.
 |-
-|<tt>generateDocument (String objectName, String recordId, String templateId, String format)</tt>||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 Class|Result object]]|| [[Java_API:Email_and_Document_Management|Email and Document Management]]|| [[Java API:Email_and_Document_Management#generateDocument |<tt> generateDocument</tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#formatTime(java.util.Date) <tt>formatTime(Date d)</tt>]
+| Format a time value.
+| Return a String with the time formatted using the user's locale.
 |-
-|<tt>getAllSavePoints()</tt>||Returns All Save Points|| Set|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#getAllSavePoints|<tt> getAllSavePoints</tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#parseCurrency(java.lang.String) <tt>parseCurrency(String value)</tt>]
+| 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.
 |-
-|<tt>getEnv (String key)</tt>||Gets the environment variable value for the key|| The value of the environment variable || [[Java_API:Utility|Utility]] ||[[Java_API:Utility#getEnv |<tt> getEnv </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#parseNumber(java.lang.String) <tt>parseNumber(String value)</tt>]
+| 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.
 |-
-|<tt>Functions.getParametersInstance()</tt>||Gets an instance of Parameters class||[[Java_API:Utility|Utility]] ||[[Parameters Class|Parameters object]]||[[Java_API:Utility#getParametersInstance |<tt> getParametersInstance </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#parsePercent(java.lang.String) <tt>parsePercent(String value)</tt>]
+| 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.
 |-
-|<tt>getRecord (String objectName, String fields, String recordId)</tt>||Gets the record of type objectId identified by recordId. fields is a comma separated list of fields that you want to fetch|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java API:Record_Handling#getRecord |<tt> getRecord </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#validateCurrency(java.lang.String) <tt>validateCurrency(String value)</tt>]
+| Verify that the currency amount is in the format specified by the company's locale setting for currencies.
+| Return <tt>true</tt> if the data is in the expected format, otherwise <tt>false</tt>.
 |-
-|<tt>logActivity (String subject, String objectName, String id, String activityByID, Parameters params)</tt>||Logs an activity|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#logActivity |<tt> logActivity </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#validateNumber(java.lang.String) <tt>validateNumber(String value)</tt>]
+| Verify that the numeric amount (with or without a fractional amount) is in the format specified by the user's locale.
+| Return <tt>true</tt> if the data is in the expected format, otherwise <tt>false</tt>.
 |-
-|<tt>processWorkflowAction (String workflowName,String currentStateName,String recordId,String customObjectName,String workflowAction,String workflowComments)</tt>||Process Work flow Action|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java_API:Record_Handling#processWorkflowAction |<tt> processWorkflowAction </tt>]]
+| [{{DOCHOST}}/javadocs/com/platform/api/Functions.html#validatePercent(java.lang.String) <tt>validatePercent(String value)</tt>]
+| Verify that the percentage is in the format specified by the user's locale.
+| Return <tt>true</tt> if the data is in the expected format, otherwise <tt>false</tt>.
+|}
+=== Utility Functions ===
+Static [[Java_API:Utility functions|Utility functions]] in the [{{DOCHOST}}/javadocs/com/platform/api/Functions.html Functions] class:
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
 |-
-|<tt>removeSavePoint (String name)</tt>||removes save point with name from save point list|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#removeSavePoint |<tt> removeSavePoint </tt>]]
+|<tt>[[Java_API:Utility functions#getEnv |getEnv]](String key)</tt>||Gets the environment variable value for the key|| The value of the environment variable
 |-
-|<tt>rollback ()</tt>||Roll backs all the inserts and updates|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#rollback |<tt> rollback </tt>]]
+|<tt>[[Java_API:Utility functions#getParametersInstance |getParametersInstance]]()</tt>||Gets an instance of Parameters class || [[Parameters Class|Parameters]] object
 |-
-|<tt>rollbackToSavePoint (String name)</tt>||Rollback to specific save point with name|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#rollbackToSavePoint |<tt> rollbackToSavePoint </tt>]]
+|<tt>[[Java_API:Utility functions#setTargetPage|setTargetPage]](String url)</tt>||Sets the target page|| None
 |-
-|<tt>searchRecords (String objectName, String fields, String criteria [, Parameters params])</tt>||Search and retrieve the records, for object of type <tt>objectId</tt>. <tt>fields</tt> is a comma-separated list of fields that you want to fetch and criteria is expressed in filter language|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java API:Record_Handling#searchRecords |<tt> searchRecords </tt>]]
+|<tt>[[Java_API:Utility functions#showMessage|showMessage]](String message)</tt>||Displays message|| None
 |-
-|<tt>sendEmail (String objectName, String id, String to, String cc, String subject, String body, String attachmentTemplateId, String attachmentIdList)</tt>||Sends an Email|| [[Result Class|Result object]]|| [[Java_API:Email_and_Document_Management|Email and Document Management]]|| [[Java API:Email_and_Document_Management#sendEmail |<tt> sendEmail </tt>]]
+|<tt>[[Java_API:Utility functions#sleep|sleep]](long millisecs)</tt>||Sleeps for the designated number of milliseconds.|| None
 |-
-|<tt>sendEmailUsingTemplate (String objectName, String recordId, String to, String cc, String subject, String bodyTemplateId, String attachmentTemplateId, String attachmentIdList)</tt>||Sends an Email evaluating Template identified by bodyTemplateId as email body|| [[Result Class|Result object]]|| [[Java_API:Email_and_Document_Management|Email and Document Management]]|| [[Java API:Email_and_Document_Management#sendEmailUsingTemplate|<tt> sendEmailUsingTemplate </tt>]]
+|<tt>[[Java_API:Utility functions#throwError|throwError]](String message)</tt>||Throws error with the message|| None
+|}
+[{{DOCHOST}}/javadocs/com/platform/api/utility/ServiceConfiguration.html ServiceConfiguration] class (static methods):
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Return Type
+!Description
+|-width="150"
 |-
-|<tt>setTargetPage (String url)</tt>||Sets the target page|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#setTargetPage|<tt>setTargetPage </tt>]]
+| <tt>[{{DOCHOST}}/javadocs/com/platform/api/utility/ServiceConfiguration.html#getServiceName() getServiceName]()</tt> || String || Returns the Service Name (e.g. company name)
+|-
+| <tt>[{{DOCHOST}}/javadocs/com/platform/api/utility/ServiceConfiguration.html#getServiceDomainURL() getServiceDomainURL]()</tt> || String || Returns the Service URL.
+|}
+===Metadata Management===
+Customization methods.
+:''Learn more:'' [[Java_API:Customize]]
+:{| border="1" cellpadding="5" cellspacing="0"
+!Syntax
+!Description
+!Return
+|-width="150"
+|<tt>[[Java_API:Customize#getObjectMetaData|getObjectMetaData]](String objectName)</tt>
+| Retrieve metadata from a {{type|}}s.
+| [{{DOCHOST}}/javadocs/com/platform/beans/CustomObjectMetaDataBean.html CustomObjectMetaDataBean]
 |-
-|<tt>showMessage (long millisecs)</tt>||Displays message|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#showMessage|<tt>showMessage </tt>]]
+|<tt>[[Java_API:Customize#getObjectMetaDataMap|getObjectMetaDataMap]]()</tt>
+| Return a map of all visible {{type|}} object metadata records, indexed by object ID.
+| Map: Object ID => [{{DOCHOST}}/javadocs/com/platform/beans/CustomObjectMetaDataBean.html CustomObjectMetaDataBean]
 |-
-|<tt>sleep(String message)</tt>||Sleeps for the designated number of milliseconds.|| None || [[Java_API:Utility|Utility]]|| [[Java_API:Utility#sleep|<tt>sleep </tt>]]
+|<tt>[[Java_API:Customize#addObjectMetaData|addObjectMetaData]]([{{DOCHOST}}/javadocs/com/platform/beans/CustomObjectMetaDataBean.html CustomObjectMetaDataBean])</tt>
+| Create a new object.
+| String:Object ID
 |-
-|<tt>throwError (String message)</tt>||Throws error with the message|| None|| [[Java_API:Utility|Utility]]|| [[Java_API:Utility#throwError|<tt>throwError </tt>]]
+|<tt>[[Java_API:Customize#updateObjectMetaData|updateObjectMetaData]]([{{DOCHOST}}/javadocs/com/platform/beans/CustomObjectMetaDataBean.html CustomObjectMetaDataBean])</tt>
+| Modify an object definition.
+| String: Object ID
 |-
-|<tt>updateEvent (String eventId, Parameters params)</tt>||Updates an event with values in params|| [[Result Class|Result object]]|| [[Java API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#updateEvent|<tt>updateEvent </tt>]]
+|<tt>[[Java_API:Customize#deleteObjectMetaData|deleteObjectMetaData]]([{{DOCHOST}}/javadocs/com/platform/beans/CustomObjectMetaDataBean.html CustomObjectMetaDataBean])</tt>
+| Deletes an object
+| None
+|-
+| colspan="4"  bgcolor="lightblue" style="height:7px" |  <!-- SPACER ROW -->
 |-
-|<tt>updateRecord (String objectName, String recordId, Params params)</tt>||Updates record of type objectId with values params. The Record is identified by recordId|| [[Result Class|Result object]]|| [[Java_API:Record_Handling|Record Handling]]|| [[Java API:Record_Handling#updateRecord |<tt> updateRecord </tt>]]
+|<tt>[[Java_API:Customize#getRecordLocator|getRecordLocator]](String objectName)</tt>
+| Get an object's [[Record Locator]] information.
+| [{{DOCHOST}}/javadocs/com/platform/beans/RecordLocatorBean.html RecordLocatorBean]
 |-
-|<tt>updateTask (String taskId, Parameters params)</tt>||Updates a task with values in params|| [[Result Class|Result object]]|| [[Java_API:Event_and_Task_Management|Event and Task Management]]|| [[Java_API:Event_and_Task_Management#updateTask |<tt> updateTask </tt>]]
+|<tt>[[Java_API:Customize#updateRecordLocator|updateRecordLocator]]([{{DOCHOST}}/javadocs/com/platform/beans/RecordLocatorBean.html RecordLocatorBean])</tt>
+| Modify an object's Record Locator Settings.
+| String:Object ID
 |}