Difference between revisions of "Java API:Field Type Reference"
From AgileApps Support Wiki
imported>Aeric (Created page with "This table shows how to format input data for the various Field Display Types in platform objects when using the Java API. {| border="1" cellpadding="5" cellspacing="0" ...") |
imported>Aeric |
||
(19 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
| Auto Number | | Auto Number | ||
| | | | ||
n/a | n/a (read only) | ||
|- | |- | ||
Line 18: | Line 18: | ||
| Currency | | Currency | ||
| | | | ||
* Specify a | * Specify a value in [[Database Format]], with no currency symbol and no separators other than the decimal point. | ||
|- | |- | ||
Line 29: | Line 24: | ||
| | | | ||
* A date. | * A date. | ||
* The field definition | * The field definition and user's [[Locale Settings]] determine how to format the value. | ||
|- | |- | ||
Line 35: | Line 30: | ||
| | | | ||
* <span id="Date_time">A date and time.<span> | * <span id="Date_time">A date and time.<span> | ||
* The field definition | * The field definition and user's [[Locale Settings]] determine how to format the value. | ||
|- | |- | ||
| [[Dependent Picklist]] | | [[Dependent Picklist]] | ||
| | | | ||
* Specify one of the picklist values. | |||
* An error is thrown if the list (determined by the parent-field dependency) doesn't include that value. | |||
|- | |- | ||
| Email Address | | Email Address | ||
| | | | ||
* A string containing text | * A string containing text in email-address format. For example: <tt>friend@somewhere.com</tt> | ||
|- | |||
| [[External Lookup]] | |||
| | |||
n/a | |||
|- | |- | ||
| File Field | | File Field | ||
| | | | ||
* To upload a file, | * To upload a file, use the instructions to [[Pages#Example: Submit Data that Includes a File Attachment|Submit data that includes a File attachment]] | ||
|- | |- | ||
Line 56: | Line 57: | ||
| | | | ||
n/a | n/a | ||
|- | |||
| Geolocation | |||
| | |||
A string containing a latitude and longitude, separated by a comma and a space.<br>Ex: <tt>37.403930662906106, -121.97971165820213</tt> | |||
|- | |- | ||
Line 65: | Line 71: | ||
| <span id="image">Image Field</span> | | <span id="image">Image Field</span> | ||
| | | | ||
* To upload an image, | * To upload an image, use the instructions to [[Pages#Example: Submit Data that Includes a File Attachment|Submit data that includes a File attachment]] | ||
|- | |- | ||
| [[Lookup]] | | 1:N [[Lookup]] | ||
| | | | ||
* Applies to a Lookup field in a One-to-Many relationship | |||
* Specify a record ID from the target object. | * Specify a record ID from the target object. | ||
|- | |||
| M:N [[Lookup]] | |||
| | |||
* Applies to a Lookup field in a Many-to-Many relationship | |||
* Specify a comma separated list of record IDs from the target object. | |||
|- | |- | ||
Line 83: | Line 96: | ||
|- | |- | ||
| [[Multi Select Picklist]] & | | [[Multi Select Picklist]]<br>&<br>Multi Select Global Picklist | ||
Multi Select Global | |||
| | | | ||
* A comma-separated list of picklist values. | * A comma-separated list of picklist values. | ||
Line 91: | Line 103: | ||
| Number | | Number | ||
| | | | ||
* | * Specify a value in [[Database Format]], with no separators other than the decimal point. | ||
* Possible values range -2,147,483,646 to 2,147,483,647 (-2147483646 to 2147483647). | |||
|- | |- | ||
| Number with decimals | | Number with decimals | ||
| | | | ||
* | * Specify a value in [[Database Format]], with no separators other than the decimal point. | ||
* The number of decimal places is specified in the field definition. | |||
|- | |- | ||
| Percentage | | Percentage | ||
| | | | ||
* | * Specify a value in [[Database Format]], with no percent sign and no separators other than the decimal point. | ||
* The value must be in the range 0 to 1. | |||
* The number of decimal places is specified in the field definition. | |||
|- | |- | ||
| Phone/Fax | | Phone/Fax | ||
| | | | ||
{{:Phone Format}} | |||
|- | |- | ||
Line 117: | Line 128: | ||
| | | | ||
*Specify one of the picklist values. | *Specify one of the picklist values. | ||
|- | |- | ||
Line 123: | Line 133: | ||
| | | | ||
* Specify one of the radio button values. | * Specify one of the radio button values. | ||
|- | |- | ||
| Rich Text Area | | Rich Text Area | ||
| | | | ||
*A string containing text and | * A string containing text and HTML tags | ||
* | * Linebreaks can be encoded using <tt>\n</tt> (newline) to make the code readable | ||
* <tt><nowiki><wbr></nowiki></tt> and <tt><nowiki></wbr></nowiki></tt> tags are not supported, as they are problematic when switching between edit and display modes. (To prevent issues, those tags are removed before the content is displayed.) | |||
|- | |- | ||
Line 135: | Line 145: | ||
| | | | ||
* A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt> | * A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt> | ||
* Linebreaks can be encoded using <tt>\n</tt> (newline) | |||
|- | |- | ||
Line 144: | Line 155: | ||
| | | | ||
* A time. For example, "6:50 PM". | * A time. For example, "6:50 PM". | ||
* The field definition | * The field definition and user's [[Locale Settings]] determine how to format the value. | ||
|- | |- |
Latest revision as of 01:35, 19 November 2014
This table shows how to format input data for the various Field Display Types in platform objects when using the Java API.
Field Display Types | Description |
---|---|
Auto Number |
n/a (read only) |
Checkbox |
|
Currency |
|
Date |
|
Date time |
|
Dependent Picklist |
|
Email Address |
|
External Lookup |
n/a |
File Field |
|
Formula |
n/a |
Geolocation |
A string containing a latitude and longitude, separated by a comma and a space. |
Global Picklist |
|
Image Field |
|
1:N Lookup |
|
M:N Lookup |
|
Multiple Checkboxes |
|
Multi Object Lookup |
|
Multi Select Picklist & Multi Select Global Picklist |
|
Number |
|
Number with decimals |
|
Percentage |
|
Phone/Fax |
If a string of digits is entered without formatting, that is the way it appears when editing, but the numbers are automatically formatted when the field is displayed:
Free-format text is displayed exactly as entered. For example:
|
Picklist |
|
Radio Buttons |
|
Rich Text Area |
|
Text Area |
|
Text Field |
|
Time |
|
URL |
|