Template:Java API

Description...

Syntax

<syntaxhighlight lang="java" enclose="div">

Result result = Functions.__apiName__(String objectName, String fields, String criteria); Result result = Functions.__apiName__(String objectName, String fields, String criteria

                           [, Parameters params] );

Result result = Functions.__apiName__(String objectName, String fields, String criteria); Result result = Functions.__apiName__(String objectName, String fields, String criteria,

                           String sortBy, String sortOrder, 
                           String sortBy2, String sortOrder2, 
                           int offset, int numberOfRows);

</syntaxhighlight>

Parameters

objectName

The object name or identifier

fields

A comma-separated list of names of the fields to retrieve

criteria

A filter expression that specifies records to select.

params

An optional Parameters object that contains additional parameters:

• param - ...

Returns

Result object

--or--

An integer containing ...

A string containing ...

Throws

Exception

Usage

• Find the object name in the Object Properties
• Get the record ID from the incoming parameters
• Use result.getID() to retrieve the returned ID
• Pass it to the Functions class getXyz() method to get a PlatformFileBean or __other item__

Example

This example ....

<syntaxhighlight lang="java" enclose="div">

... </syntaxhighlight>