Difference between revisions of "Template:Java API"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
;Syntax:
;Syntax:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
Result result = Functions.__apiName__(String objectId, String fields, String criteria);  
Result result = Functions.__apiName__(String objectName, String fields, String criteria);  
Result result = Functions.__apiName__(String objectId, String fields, String criteria  
Result result = Functions.__apiName__(String objectName, String fields, String criteria  
                             [, Parameters params] );
                             [, Parameters params] );
Result result = Functions.__apiName__(String objectId, String fields, String criteria);
Result result = Functions.__apiName__(String objectName, String fields, String criteria);
Result result = Functions.__apiName__(String objectId, String fields, String criteria,
Result result = Functions.__apiName__(String objectName, String fields, String criteria,
                             String sortBy, String sortOrder,  
                             String sortBy, String sortOrder,  
                             String sortBy2, String sortOrder2,  
                             String sortBy2, String sortOrder2,  
Line 15: Line 15:


;Parameters:
;Parameters:
:;objectId:The object identifier
:;objectName:The object name or identifier
:;fields:A comma-separated list of names of the fields to retrieve
:;fields:A comma-separated list of names of the fields to retrieve
:;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: An optional [[Parameters Class|Parameters]] object that contains additional parameters:
:::*''' param -''' ...
:::*''' param -''' ...


Line 34: Line 34:
...
...
</syntaxhighlight>
</syntaxhighlight>
<!--ACTIVATE THE CATEGORY BELOW
<!--ACTIVATE THE CATEGORY BELOW FOR MAIN "COLLECTION" PAGES (not for individual methods)
<noinclude>
<noinclude>



Latest revision as of 01:44, 3 December 2011

Description...

Syntax
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);
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
Example
This example ....
...