Difference between revisions of "Java API"
imported>Aeric |
imported>Aeric |
||
| Line 24: | Line 24: | ||
===Record Handling=== | ===Record Handling=== | ||
====Objects=== | ====Objects===H | ||
Handle records in standard [[Objects]]: | |||
:* [[Java API:Record_Handling#addRecord|<tt>addRecord</tt>]] | :* [[Java API:Record_Handling#addRecord|<tt>addRecord</tt>]] | ||
:* [[Java API:Record_Handling#updateRecord|<tt>updateRecord</tt>]] | :* [[Java API:Record_Handling#updateRecord|<tt>updateRecord</tt>]] | ||
| Line 36: | Line 36: | ||
:* [[Java API:Record_Handling#execSQL|<tt>execSQL</tt>]] | :* [[Java API:Record_Handling#execSQL|<tt>execSQL</tt>]] | ||
:''Learn more:'' [[Java_API:Record_Handling]] | :''Learn more:'' [[Java_API:Record_Handling]] | ||
====Composite Objects==== | ====Composite Objects==== | ||
Revision as of 23:02, 18 September 2013
The Java API is a set of built-in calls that are made to programmatically customize and extend the platform.
1 About the Java API
The following platform elements provide the ability to make Java API calls from the user interface (UI):
2 Prerequisites
You must know the Java programming language to make the Java API calls. This includes knowing the basic elements of Java such as conditional structures (if statement), looping structures (while and for loop statements), variable declaration and assignment, use of operators, variable naming conventions, debugging techniques, and so on.
- Learn more about the platform:
- Learn more about web services and programming:
3 Classes, Objects, and APIs
This table lists the APIs and links to detail pages. For a quick synopsis of syntax, see the Java API Cheatsheet.
3.1 Record Handling
====Objects===H Handle records in standard Objects:
- Learn more: Java_API:Record_Handling
3.1.1 Composite Objects
To operate on records in Composite Objects:
- Learn more: Working with Composite Objects
3.1.2 Tenant Data Sharing
To handle records in Objects shared using Tenant Data Sharing Policies
3.2 Relay
To do social networking.
- Messages
- addSocialFeed (post a msg)
- getSocialFeed (get msg)
- deleteSocialFeed (delete msg)
- searchSocialFeeds (search msgs)
- Messages
- Message Voting
- Following Feeds
3.3 Data Import
Import CSV data into Objects
- Learn more: Java_API:Data Import
3.4 Email and Document Management
APIs to manage Email and documents.
- Learn more: Java_API:Email_and_Document_Management
3.5 Transaction Management
Provides the ability to Rollback transactions to a SavePoint
- Learn more: Java_API:Transaction_Management
3.6 Support Classes and Objects
Use these support classes and objects when you work with the Java API.
- Functions class
- HttpConnection class
- Parameters class
- ParametersIterator class
- Result class
- SearchContext class
- Learn more: Java_API:Support_Classes_and_Objects
3.7 Localization Functions
Use these functions to convert between Database Formats and localized User Formats.
- Learn more: Localization
3.8 Utility Functions
General-purpose operations.
- debug - Deprecated
Use Logger class. (See Debug Log) - getEnv
- getParametersInstance
- getTimezonesUtility
- getTimezoneUtility
- getLoggedInUserInfo
- setTargetPage
- showMessage
- sleep
- throwError
- translateToken
- debug - Deprecated
- Learn more: Utility functions
3.9 Customization APIs
Use these Provisional APIs give to manage metadata for program entities.
- Learn more: Customize
3.10 Status
Check status of scheduled jobs.
- Learn more: getStatus
4 Identifying Objects and Records
An object type identifier uniquely identifies an object type. It is used to specify object types in APIs.
There are two kinds of type identifiers:
- objectName: This identifier is a human-readable name for both System Objects and Custom Objects.
- objectID: This identifier is a human-readable name for System Objects (e.g. "cases"), but for Custom Objects, it is a computer-generated string with no humanly-interpretable semantic value (e.g. 123qwe456rty).
- See also:
- Session Identifier - session identifier
- Record Id - record id
To find an object type identifier:
- Click
> Customization > Objects - In the Display Title column, find the object you're looking for.
- The Object Name column has the identifier you need.
Alternatively:
- Go to > Customization > Objects > {object}
- Click Properties
- The object name appears at the top of the page
Note:
- For objects that are not listed, see the System Objects page.
- The Object Name is typically used as the identifier, because it is human-readable for both System Objects and Custom Objects. Object ID can be used, as well, but it is human-readable only for System Objects.
