Difference between revisions of "Commonly Used Constants"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
Constants are defined in the {{constants}} class. See that class and its subclasses for a complete reference.
Constants are defined in the {{^Constants}} class. On that page, follow the links in the '''Nested Class Summary''' for a complete guide to {{EnterpriseBrand}} constants. For convenience, some of the more common constants used in the [[Java API]]s are listed here.
 
<noinclude>__TOC__</noinclude>
Some of the most common constants used in the [[Java API]]s are described here.
{{Note|
 
:* Constants have all-uppercase names, and are listed as <tt>static</tt> in the '''Field Summary'''. For example: <tt>static String CONTAINS</tt>
==Documents==
:* Some of the classes have nested classes of their own. Keep drilling down until you find the constant you need.
}}
<blockquote>
====Documents====


{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
Line 15: Line 18:
|}
|}


==Search==
====Search====


{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
Line 27: Line 30:
|}
|}


==HttpConnection==
====HttpConnection====


{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
Line 39: Line 42:
|}
|}


==Request Parameter==
====Request Parameter====


{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
Line 48: Line 51:
| ... || ... || ...
| ... || ... || ...
|-
|-
|CONSTANTS.SEARCH.SEARCH_RESULTS||Retrieve search results||[[Data Policy]]<br/>Ex:
|CONSTANTS.SEARCH.SEARCH_RESULTS||Retrieve search results||
[[Data Policy#Using a Data Policy to Mask Social Security Numbers|Using a Data Policy to Mask Social Security Numbers]]
|}
|}
</blockquote>

Latest revision as of 21:00, 12 June 2014

Constants are defined in the CONSTANTS class. On that page, follow the links in the Nested Class Summary for a complete guide to AgileApps Cloud platform constants. For convenience, some of the more common constants used in the Java APIs are listed here.

Notepad.png

Note:

  • Constants have all-uppercase names, and are listed as static in the Field Summary. For example: static String CONTAINS
  • Some of the classes have nested classes of their own. Keep drilling down until you find the constant you need.

Documents

Constant Name Description Used in function
CONSTANTS.DOCUMENT.HTML HTML format generateDocument
CONSTANTS.DOCUMENT.PDF PDF format generateDocument

Search

Constant Name Description Used in function
CONSTANTS.SEARCH.SORT_ASCENDING Ascending order searchRecords
CONSTANTS.SEARCH.SORT_DESCENDING Descending order searchRecords

HttpConnection

Constant Name Description Used in function
CONSTANTS.HTTP. METHOD.GET HTTP GET request HttpConnection Constructor
CONSTANTS.HTTP. METHOD.POST HTTP POST request HttpConnection Constructor

Request Parameter

Constant Name Description Used in
... ... ...
CONSTANTS.SEARCH.SEARCH_RESULTS Retrieve search results