Difference between revisions of "Template:Java API"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (4 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 | Result result = Functions.__apiName__(String objectName, String fields, String criteria); | ||
Result result = Functions.__apiName__(String | Result result = Functions.__apiName__(String objectName, String fields, String criteria | ||
[, Parameters params] ); | [, Parameters params] ); | ||
Result result = Functions.__apiName__(String | Result result = Functions.__apiName__(String objectName, String fields, String criteria); | ||
Result result = Functions.__apiName__(String | 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: | ||
:; | :;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. | ||
| Line 29: | Line 29: | ||
;Throws: | ;Throws: | ||
:Exception | :Exception | ||
;Usage: | |||
::* Find the object name in the [[Object Properties]] | |||
::* Get the record ID from the [[incoming parameters]] | |||
::* Use <tt>result.getID()</tt> to retrieve the returned ID | |||
::* Pass it to the {{^Fcn}} <tt>getXyz()</tt> method to get a {{^PlatformFileBean}} or __other item__ | |||
;Example:This example .... | ;Example:This example .... | ||
| Line 34: | Line 40: | ||
... | ... | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<!--ACTIVATE THE CATEGORY BELOW | <!--ACTIVATE THE CATEGORY BELOW FOR MAIN "COLLECTION" PAGES (not for individual methods) | ||
<noinclude> | <noinclude> | ||
Latest revision as of 03:27, 16 January 2014
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>