Edit D:\app\Administrator\product\11.2.0\dbhome_1\apex\images\doc\AEAPI\preface.htm
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <title>Preface</title> <meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1" /> <meta name="date" content="2009-04-14T17:32:15Z" /> <meta name="robots" content="noarchive" /> <meta name="doctitle" content="Preface" /> <meta name="relnum" content="Release 3.2" /> <meta name="partnum" content="E12510-01" /> <link rel="copyright" href="../dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> <link rel="stylesheet" href="../dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" /> <link rel="contents" href="toc.htm" title="Contents" type="text/html" /> <link rel="up" href="preface" title="Home" type="text/html" /> <link rel="up" href="preface.htm" title="Preface" type="text/html" /> <link rel="prev" href="title.htm" title="Previous" type="text/html" /> <link rel="next" href="apex_util.htm" title="Next" type="text/html" /> </head> <body> <p id="BREADCRUMBING"><a href="preface" title="Home">Home</a> > Preface</p> <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> <col width="86%" /> <col width="*" /> <tr valign="bottom"> <td align="left"></td> <td align="center"><a href="title.htm"><img src="../dcommon/gifs/leftnav.gif" alt="Previous" /><br /> <span class="icon">Previous</span></a> </td> <td align="center"><a href="apex_util.htm"><img src="../dcommon/gifs/rightnav.gif" alt="Next" /><br /> <span class="icon">Next</span></a></td> </tr> </table> <p><a id="sthref2" name="sthref2"></a></p> <h1>Preface</h1> <p><span class="italic">Oracle Application Express API Reference</span> describes the Application Programming Interfaces, referred to as APIs, available when programming in the Oracle Application Express environment.</p> <p><a id="sthref3" name="sthref3"></a></p> <p class="subhead2">Topics:</p> <ul> <li> <p><a href="#CIAFDJCA">Topic Overview</a></p> </li> <li> <p><a href="#BABFEFEA">Audience</a></p> </li> <li> <p><a href="#CIAJFCDG">Documentation Accessibility</a></p> </li> <li> <p><a href="#i972232">Related Documents</a></p> </li> <li> <p><a href="#i971172">Conventions</a></p> </li> </ul> <p><a id="CIAFDJCA" name="CIAFDJCA"></a></p> <h2>Topic Overview</h2> <p>Topics in this help set include:</p> <div class="inftblinformal"> <table class="Informal" summary="This table describes the structure and content of this document." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> <col width="37%" /> <col width="*" /> <thead> <tr align="left" valign="top"> <th align="left" valign="bottom" id="r1c1-t2">Title</th> <th align="left" valign="bottom" id="r1c2-t2">Description</th> </tr> </thead> <tbody> <tr align="left" valign="top"> <td align="left" id="r2c1-t2" headers="r1c1-t2"><a href="apex_util.htm#CHDIEDJH">APEX_UTIL</a><br /></td> <td align="left" headers="r2c1-t2 r1c2-t2">Use the <code>APEX_UTIL</code> package to get and set session state, get files, check authorizations for users, reset different states for users, and also to get and set preferences for users.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r3c1-t2" headers="r1c1-t2"><a href="apex_mail.htm#CIHDIEJI">APEX_MAIL</a><br /></td> <td align="left" headers="r3c1-t2 r1c2-t2">Use the <code>APEX_MAIL</code> package to send an email from an Oracle Application Express application.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r4c1-t2" headers="r1c1-t2"><a href="apex_item.htm#CACEEEJE">APEX_ITEM</a><br /></td> <td align="left" headers="r4c1-t2 r1c2-t2">Use the <code>APEX_ITEM</code> package to create form elements dynamically based on a SQL query instead of creating individual items page by page.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r5c1-t2" headers="r1c1-t2"><a href="apex_app.htm#CHDDADIE">APEX_APPLICATION</a><br /></td> <td align="left" headers="r5c1-t2 r1c2-t2">Use the <code>APEX_APPLICATION</code> package to take advantage of a number of global variables.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r6c1-t2" headers="r1c1-t2"><a href="apex_auth.htm#CEGHIDHC">APEX_CUSTOM_AUTH</a><br /></td> <td align="left" headers="r6c1-t2 r1c2-t2">Use the <code>APEX_CUSTOM_AUTH</code> package to perform various operations related to authentication and session management.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r7c1-t2" headers="r1c1-t2"><a href="apex_ldap.htm#CEGDCAFD">APEX_LDAP</a><br /></td> <td align="left" headers="r7c1-t2 r1c2-t2">Use <code>APEX_LDAP</code> to perform various operations related to Lightweight Directory Access Protocol (LDAP) authentication.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r8c1-t2" headers="r1c1-t2"><a href="apex_instance.htm#CACGJEDD">APEX_INSTANCE_ADMIN</a><br /></td> <td align="left" headers="r8c1-t2 r1c2-t2">Use the <code>APEX_INSTANCE_ADMIN</code> package to get and set email settings, wallet settings, report printing settings and to manage schema to workspace mappings.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r9c1-t2" headers="r1c1-t2"><a href="apex_ui_default.htm#CICBHBJJ">APEX_UI_DEFAULT_UPDATE</a><br /></td> <td align="left" headers="r9c1-t2 r1c2-t2">You can use the <code>APEX_UI_DEFAULT_UPDATE</code> package to set the user interface defaults associated with a table within a schema. The package must be called from within the schema that owns the table you are updating.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r10c1-t2" headers="r1c1-t2"><a href="javascript_api.htm#CDEEIGFH">JavaScript APIs</a><br /></td> <td align="left" headers="r10c1-t2 r1c2-t2">Use these JavaScript functions and objects to provide client-side functionality, such as showing and hiding page elements, or making XML HTTP Asynchronous JavaScript and XML (AJAX) requests.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r11c1-t2" headers="r1c1-t2"><a href="apex_plsql_job.htm#BGBFGBIB">APEX_PLSQL_JOB</a><br /></td> <td align="left" headers="r11c1-t2 r1c2-t2">Use <code>APEX_PLSQL_JOB</code> package to run PL/SQL code in the background of your application. This is an effective approach for managing long running operations that do not need to complete for a user to continue working with your application.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r12c1-t2" headers="r1c1-t2"><a href="apex_lang.htm#CHDFEFBH">APEX_LANG</a><br /></td> <td align="left" headers="r12c1-t2 r1c2-t2">Use <code>APEX_LANG</code> API to translate messages.</td> </tr> </tbody> </table> <br /></div> <!-- class="inftblinformal" --> <div align="center"> <div class="inftblnote"><br /> <table class="Note oac_no_warn" summary="" cellpadding="3" cellspacing="0"> <tbody> <tr> <td align="left"> <p class="notep1">Note:</p> In release 2.2, Oracle Application Express APIs were renamed using the prefix <code>APEX_</code>. Note that API's using the previous prefix <code>HTMLDB_</code> are still supported to provide backward compatibility. As a best practice, however, use the new API names for new applications unless you plan to run them in an earlier version of Oracle Application Express.</td> </tr> </tbody> </table> <br /></div> <!-- class="inftblnote" --></div> <p><a id="BABFEFEA" name="BABFEFEA"></a></p> <h2>Audience</h2> <p><span class="italic">Oracle Application Express API Reference</span> is intended for application developers who are building database-centric Web applications using Oracle Application Express. The guide describes the APIs available when programming in the Oracle Application Express environment.</p> <p>To use this guide, you need to have a general understanding of relational database concepts as well as an understanding of the operating system environment under which you are running Oracle Application Express.</p> <div align="center"> <div class="inftblnotealso"><br /> <table class="NoteAlso oac_no_warn" summary="" cellpadding="3" cellspacing="0"> <tbody> <tr> <td align="left"> <p class="notep1">See Also:</p> <span class="italic"><a href="../TDPAX/preface.htm">Oracle 2 Day + Application Express Developer's Guide</a></span></td> </tr> </tbody> </table> <br /></div> <!-- class="inftblnotealso" --></div> <p><a id="CIAJFCDG" name="CIAJFCDG"></a></p> <h2>Documentation Accessibility</h2> <p>Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at <code><a href="http://www.oracle.com/accessibility/">http://www.oracle.com/accessibility/</a></code>.</p> <p><a id="sthref4" name="sthref4"></a></p> <p class="subhead2">Accessibility of Code Examples in Documentation</p> <p>Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.</p> <p><a id="sthref5" name="sthref5"></a></p> <p class="subhead2">Accessibility of Links to External Web Sites in Documentation</p> <p>This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.</p> <p><a id="sthref6" name="sthref6"></a></p> <p class="subhead2">Deaf/Hard of Hearing Access to Oracle Support Services</p> <p>To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at <code><a href="http://www.fcc.gov/cgb/consumerfacts/trs.html">http://www.fcc.gov/cgb/consumerfacts/trs.html</a></code>, and a list of phone numbers is available at <code><a href="http://www.fcc.gov/cgb/dro/trsphonebk.html">http://www.fcc.gov/cgb/dro/trsphonebk.html</a></code>.</p> <p><a id="i972232" name="i972232"></a></p> <h2>Related Documents</h2> <p>For more information, see these Oracle resources:</p> <ul> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=HTMRN"><span class="italic">Oracle Application Express Release Notes</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=HTMIG"><span class="italic">Oracle Application Express Installation Guide</span></a></p> </li> <li> <p><a href="../TDPAX/preface.htm"><span class="italic">Oracle 2 Day + Application Express Developer's Guide</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=HTMAD"><span class="italic">Oracle Application Express Advanced Tutorials</span></a></p> </li> <li> <p><a href="../AEADM/preface.htm"><span class="italic">Oracle Application Express Administration Guide</span></a></p> </li> <li> <p><a href="../AEMIG/preface.htm"><span class="italic">Oracle Application Express Migration Guide</span></a></p> </li> <li> <p><a href="../AEUTL/preface.htm"><span class="italic">Oracle Application Express SQL Workshop and Utilities Guide</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=CNCPT"><span class="italic">Oracle Database Concepts</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=ADFNS"><span class="italic">Oracle Database Advanced Application Developer's Guide</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=ADMIN"><span class="italic">Oracle Database Administrator's Guide</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=SQLRF"><span class="italic">Oracle Database SQL Language Reference</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=SQPUG"><span class="italic">SQL*Plus User's Guide and Reference</span></a></p> </li> <li> <p><a href="http://www.oracle.com/pls/db112/lookup?id=LNPLS"><span class="italic">Oracle Database PL/SQL Language Reference</span></a></p> </li> </ul> <p>For information about Oracle error messages, see <span class="italic"><a href="http://www.oracle.com/pls/db112/lookup?id=ERRMG">Oracle Database Error Messages</a></span>. Oracle error message documentation is available only in HTML. If you have access to the Oracle Database Documentation Library, you can browse the error messages by range. Once you find the specific range, use your browser's "find in page" feature to locate the specific message. When connected to the Internet, you can search for a specific error message using the error message search feature of the Oracle online documentation.</p> <p>Many books in the documentation set use the sample schemas of the seed database, which is installed by default when you install Oracle. Refer to <span class="italic"><a href="http://www.oracle.com/pls/db112/lookup?id=COMSC">Oracle Database Sample Schemas</a></span> for information on how these schemas were created and how you can use them yourself.</p> <p>For additional documentation available on Oracle's Technology Network, please visit the Oracle Application Express web site located at</p> <p><code><a href="http://www.oracle.com/technology/products/database/application_express/">http://www.oracle.com/technology/products/database/application_express/</a></code></p> <p>For additional application examples, please visit the Oracle by Examples (OBEs) Application Express page, located on Oracle's Technology Network. The OBEs provide step-by-step examples with screenshots on how to perform various tasks within Application Express.</p> <p><code><a href="http://www.oracle.com/technology/products/database/application_express/html/obes.html">http://www.oracle.com/technology/products/database/application_express/html/obes.html</a></code></p> <p>Printed documentation is available for sale in the Oracle Store at</p> <p><code><a href="http://oraclestore.oracle.com/">http://oraclestore.oracle.com/</a></code></p> <p>To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at</p> <p><code><a href="http://www.oracle.com/technology/membership/">http://www.oracle.com/technology/membership/</a></code></p> <p>If you already have a user name and password for OTN, then you can go directly to the documentation section of the OTN Web site at</p> <p><code><a href="http://www.oracle.com/technology/documentation/">http://www.oracle.com/technology/documentation/</a></code></p> <p><a id="i971172" name="i971172"></a></p> <h2>Conventions</h2> <p>For a description of PL/SQL subprogram conventions, refer to the <a href="http://www.oracle.com/pls/db112/lookup?id=LNPLS"><span class="italic">Oracle Database PL/SQL Language Reference</span></a>. This document contains the following information:</p> <ul> <li> <p>Specifying subprogram parameter modes</p> </li> <li> <p>Specifying default values for subprogram parameters</p> </li> <li> <p>Overloading PL/SQL subprogram Names</p> </li> </ul> <p>The following text conventions are used in this document:</p> <div class="inftblinformal"> <table class="Informal" title="Conventions Table" summary="This table summarizes conventions used in this document." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> <col width="24%" /> <col width="*" /> <thead> <tr align="left" valign="top"> <th align="left" valign="bottom" id="r1c1-t5">Convention</th> <th align="left" valign="bottom" id="r1c2-t5">Meaning</th> </tr> </thead> <tbody> <tr align="left" valign="top"> <td align="left" id="r2c1-t5" headers="r1c1-t5"><span class="bold">boldface</span></td> <td align="left" headers="r2c1-t5 r1c2-t5">Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r3c1-t5" headers="r1c1-t5"><span class="italic">italic</span></td> <td align="left" headers="r3c1-t5 r1c2-t5">Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.</td> </tr> <tr align="left" valign="top"> <td align="left" id="r4c1-t5" headers="r1c1-t5"><code>monospace</code></td> <td align="left" headers="r4c1-t5 r1c2-t5">Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.</td> </tr> </tbody> </table> <br /></div> <!-- class="inftblinformal" --> <!-- Start Footer --> <div class="footer"> <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> <col width="86%" /> <col width="*" /> <tr> <td align="left"><span class="copyrightlogo">Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.</span><br /> <a href="../dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td> <td align="center"><a href="title.htm"><img src="../dcommon/gifs/leftnav.gif" alt="Previous" /><br /> <span class="icon">Previous</span></a> </td> <td align="center"><a href="apex_util.htm"><img src="../dcommon/gifs/rightnav.gif" alt="Next" /><br /> <span class="icon">Next</span></a></td> </tr> </table> </div> <!-- class="footer" --> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de