Difference between revisions of "Commonly Used Constants"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 2: Line 2:


{{Note|
{{Note|
:* Constants have all-uppercase names, and are listed as <tt>static</tt> in the '''Field Summary'''. For example: <tt>static String CONTAINS </tt>.
:* Constants have all-uppercase names, and are listed as <tt>static</tt> in the '''Field Summary'''. For example: <tt>static String CONTAINS</tt>
:* Some of the classes have nested classes of their own. Keep drilling down until you find the constant you need.
:* Some of the classes have nested classes of their own. Keep drilling down until you find the constant you need.
}}
}}

Revision as of 23:09, 24 June 2011

Constants are defined in the Template:Constants class. Follow the links on that page to the Nested Class Summary, for a complete guide to AgileApps Cloud platform constants.

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.

For convenience, some of the more common constants used in the Java APIs are listed here.

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 Data Policy
Ex:

Using a Data Policy to Mask Social Security Numbers