AgileApps Support Wiki Pre Release

Difference between revisions of "Java API"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 25: Line 25:
===Record Handling===
===Record Handling===
====Objects====
====Objects====
Handle records in standard [[Objects]]:
: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 39: Line 39:


====Composite Objects====
====Composite Objects====
Operate on records in [[Composite Object]]s:
:Operate on records in [[Composite Object]]s:
:* [[Java API:Composite Objects#getRecordCount|<tt>getRecordCount</tt>]]
:* [[Java API:Composite Objects#getRecordCount|<tt>getRecordCount</tt>]]
:* [[Java API:Composite Objects#getRecord|<tt>getRecord</tt>]]
:* [[Java API:Composite Objects#getRecord|<tt>getRecord</tt>]]
Line 47: Line 47:


====Tenant Data Sharing====
====Tenant Data Sharing====
Handle records in Objects shared using [[Tenant Data Sharing Policies]]:
:Handle records in Objects shared using [[Tenant Data Sharing Policies]]:
:* [[Tenant_Data_Sharing_Policies#addRecord|<tt>addRecord</tt>]]
:* [[Tenant_Data_Sharing_Policies#addRecord|<tt>addRecord</tt>]]
:* [[Tenant_Data_Sharing_Policies#updateRecord|<tt>updateRecord</tt>]]
:* [[Tenant_Data_Sharing_Policies#updateRecord|<tt>updateRecord</tt>]]
Line 58: Line 58:


:''Learn more:'' [[Tenant_Data_Sharing_Policies#Using the JAVA API to Access Shared Data]]
:''Learn more:'' [[Tenant_Data_Sharing_Policies#Using the JAVA API to Access Shared Data]]
====Data Import====
:Import CSV data into [[Object]]s
:* [[Java_API:Data Import#getMappingProfiles|<tt>getMappingProfiles</tt>]]
:* [[Java_API:Data Import#importData|<tt>importData</tt>]]
:''Learn more:'' [[Java_API:Data Import]]


===<span id="relay">Relay</span>===
===<span id="relay">Relay</span>===
Line 88: Line 95:
:*:* [[Java_API:Relay#getSocialNotificationsList|<tt>getSocialNotificationsList</tt>]]   
:*:* [[Java_API:Relay#getSocialNotificationsList|<tt>getSocialNotificationsList</tt>]]   
:*:* [[Java_API:Relay#setAllSocialNotificationsRead|<tt>setAllSocialNotificationsRead</tt>]]   
:*:* [[Java_API:Relay#setAllSocialNotificationsRead|<tt>setAllSocialNotificationsRead</tt>]]   
===Data Import===
Import CSV data into [[Object]]s
:* [[Java_API:Data Import#getMappingProfiles|<tt>getMappingProfiles</tt>]]
:* [[Java_API:Data Import#importData|<tt>importData</tt>]]
:''Learn more:'' [[Java_API:Data Import]]


===Email and Document Management===
===Email and Document Management===

Revision as of 23:04, 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):

  • Standard Java classes, to create custom business logic that models your organization's environment
  • JSP Pages, which can invoke Java APIs

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

3.1.1 Objects

Handle records in standard Objects:
Learn more: Java_API:Record_Handling

3.1.2 Composite Objects

Operate on records in Composite Objects:
Learn more: Working with Composite Objects

3.1.3 Tenant Data Sharing

Handle records in Objects shared using Tenant Data Sharing Policies:
Learn more: Tenant_Data_Sharing_Policies#Using the JAVA API to Access Shared Data

3.1.4 Data Import

Import CSV data into Objects
Learn more: Java_API:Data Import

3.2 Relay

To do social networking.

3.3 Email and Document Management

APIs to manage Email and documents.


Learn more: Java_API:Email_and_Document_Management

3.4 Transaction Management

Provides the ability to Rollback transactions to a SavePoint

Learn more: Java_API:Transaction_Management

3.5 Support Classes and Objects

Use these support classes and objects when you work with the Java API.


Learn more: Java_API:Support_Classes_and_Objects

3.6 Localization Functions

Use these functions to convert between Database Formats and localized User Formats.

Learn more: Localization

3.7 Utility Functions

General-purpose operations.


Learn more: Utility functions

3.8 Customization APIs

Use these Provisional APIs give to manage metadata for program entities.

Learn more: Customize

3.9 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:

To find an object type identifier:

  1. Click GearIcon.png > Customization > Objects
  2. In the Display Title column, find the object you're looking for.
  3. The Object Name column has the identifier you need.

Alternatively:

  1. Go to GearIcon.png > Customization > Objects > {object}
  2. Click Properties
  3. The object name appears at the top of the page

Notepad.png

Note: