Difference between revisions of "Template:Java API"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 19: Line 19:
:;criteria:A [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select.
:;criteria:A [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select.
:;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters.
:;params: Optional. A [[Parameters Class|Parameters]] object that contains additional parameters.
::*...other parameters...
::*''' param -''' ...


;Returns:
;Returns:

Revision as of 01:23, 16 September 2011

Description...

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

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

                           [, Parameters params] );

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

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

</syntaxhighlight>

Parameters
objectId
The object identifier
fields
A comma-separated list of names of the fields to retrieve
criteria
A filter expression that specifies records to select.
params
Optional. A Parameters object that contains additional parameters.
  • param - ...
Returns
Result object

--or--

An integer containing ...
A string containing ...
Throws
Exception
Example
This example ....
<syntaxhighlight lang="java" enclose="div">

... </syntaxhighlight>