Oracle Application Express

Oracle? Application Express

API Reference Release 5.1

E64915-04

June 2017

Oracle Application Express API Reference, Release 5.1 E64915-04 Copyright ? 2003, 2017, Oracle and/or its affiliates. All rights reserved. Primary Author: Harish Konakondla Contributors: Terri Jennings, Christina Cho, Hilary Farrell , Joel Kallman, Sharon Kennedy, Christian Neumueller, Anthony Raynor, Marc Sewtz, John Snyders, Jason Straub, Drue Swadener, Vladislav Unarov, Patrick Wolf This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agencyspecific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface ............................................................................................................................................................. xxv

Audience .................................................................................................................................................... xxv Documentation Accessibility .................................................................................................................. xxv Related Documents.................................................................................................................................. xxvi Conventions.............................................................................................................................................. xxvi

Changes in This Release ..................................................................................................................... xxvii

Changes in Oracle Application Express Release 5.1.......................................................................... xxvii New Features .................................................................................................................................. xxvii Deprecated and Desupported Features ....................................................................................... xxix

1 APEX_APPLICATION

1.1 Global Variables ................................................................................................................................ 1-1 1.2 Referencing Arrays ........................................................................................................................... 1-2 1.3 Referencing Values Within an On Submit Process ...................................................................... 1-3 1.4 Converting an Array to a Single Value.......................................................................................... 1-3 1.5 HELP Procedure ............................................................................................................................... 1-3 1.6 STOP_APEX_ENGINE Procedure ................................................................................................. 1-5

2 APEX_APPLICATION_INSTALL

2.1 Package Overview ............................................................................................................................ 2-2 2.2 Attributes Manipulated by APEX_APPLICATION_INSTALL ................................................. 2-2 2.3 Import Script Examples ................................................................................................................... 2-3 2.4 CLEAR_ALL Procedure................................................................................................................... 2-5 2.5 GENERATE_APPLICATION_ID Procedure................................................................................ 2-5 2.6 GENERATE_OFFSET Procedure.................................................................................................... 2-6 2.7 GET_APPLICATION_ALIAS Function......................................................................................... 2-6 2.8 GET_APPLICATION_ID Function ................................................................................................ 2-7 2.9 GET_APPLICATION_NAME Function ........................................................................................ 2-7 2.10 GET_AUTO_INSTALL_SUP_OBJ Function ............................................................................... 2-8 2.11 GET_IMAGE_PREFIX Function ................................................................................................... 2-8

iii

2.12 GET_KEEP_SESSIONS Function.................................................................................................. 2-9 2.13 GET_OFFSET Function .................................................................................................................. 2-9 2.14 GET_PROXY Function ................................................................................................................. 2-10 2.15 GET_SCHEMA Function ............................................................................................................. 2-10 2.16 GET_WORKSPACE_ID Function............................................................................................... 2-11 2.17 SET_APPLICATION_ALIAS Procedure ................................................................................... 2-11 2.18 SET_APPLICATION_ID Procedure........................................................................................... 2-12 2.19 SET_APPLICATION_NAME Procedure .................................................................................. 2-13 2.20 SET_AUTO_INSTALL_SUP_OBJ Procedure ........................................................................... 2-13 2.21 SET_IMAGE_PREFIX Procedure................................................................................................ 2-14 2.22 SET_KEEP_SESSIONS Procedure .............................................................................................. 2-15 2.23 SET_OFFSET Procedure .............................................................................................................. 2-15 2.24 SET_PROXY Procedure................................................................................................................ 2-16 2.25 SET_SCHEMA Procedure ........................................................................................................... 2-17 2.26 SET_WORKSPACE_ID Procedure ............................................................................................. 2-17 2.27 SET_WORKSPACE_Procedure .................................................................................................. 2-18

3 APEX_AUTHENTICATION

3.1 Constants............................................................................................................................................ 3-1 3.2 CALLBACK Procedure .................................................................................................................... 3-1 3.3 GET_CALLBACK_URL Function .................................................................................................. 3-3 3.4 GET_LOGIN_USERNAME_COOKIE Function........................................................................... 3-3 3.5 IS_AUTHENTICATED Function.................................................................................................... 3-4 3.6 IS_PUBLIC_USER Function ............................................................................................................ 3-4 3.7 LOGIN Procedure............................................................................................................................. 3-5 3.8 LOGOUT Procedure......................................................................................................................... 3-6 3.9 POST_LOGIN Procedure................................................................................................................. 3-6 3.10 SEND_LOGIN_USERNAME_COOKIE Procedure ................................................................... 3-7

4 APEX_AUTHORIZATION

4.1 ENABLE_DYNAMIC_GROUPS Procedure ................................................................................. 4-1 4.2 IS_AUTHORIZED Function............................................................................................................ 4-2 4.3 RESET_CACHE Procedure ............................................................................................................. 4-3

5 APEX_COLLECTION

5.1 About the APEX_COLLECTION API............................................................................................ 5-3 5.2 Naming Collections .......................................................................................................................... 5-3 5.3 Creating a Collection ........................................................................................................................ 5-4 5.4 About the Parameter p_generate_md5.......................................................................................... 5-5 5.5 Accessing a Collection...................................................................................................................... 5-5 5.6 Merging Collections ......................................................................................................................... 5-6 5.7 Truncating a Collection.................................................................................................................... 5-6 5.8 Deleting a Collection ........................................................................................................................ 5-6

iv

5.9 Deleting All Collections for the Current Application ................................................................. 5-6 5.10 Deleting All Collections in the Current Session ......................................................................... 5-6 5.11 Adding Members to a Collection ................................................................................................. 5-7 5.12 About the Parameters p_generate_md5, p_clob001, p_blob001, and p_xmltype001 .......... 5-7 5.13 Updating Collection Members...................................................................................................... 5-7 5.14 Deleting Collection Members........................................................................................................ 5-8 5.15 Obtaining a Member Count .......................................................................................................... 5-8 5.16 Resequencing a Collection............................................................................................................. 5-8 5.17 Verifying Whether a Collection Exists......................................................................................... 5-9 5.18 Adjusting a Member Sequence ID................................................................................................ 5-9 5.19 Sorting Collection Members ......................................................................................................... 5-9 5.20 Clearing Collection Session State ................................................................................................. 5-9 5.21 Determining Collection Status .................................................................................................... 5-10 5.22 ADD_MEMBER Procedure ......................................................................................................... 5-10 5.23 ADD_MEMBER Function............................................................................................................ 5-12 5.24 ADD_MEMBERS Procedure ....................................................................................................... 5-13 5.25 COLLECTION_EXISTS Function ............................................................................................... 5-15 5.26 COLLECTION_HAS_CHANGED Function ............................................................................ 5-15 5.27 COLLECTION_MEMBER_COUNT Function.......................................................................... 5-16 5.28 CREATE_COLLECTION Procedure.......................................................................................... 5-16 5.29 CREATE_OR_TRUNCATE_COLLECTION Procedure ......................................................... 5-17 5.30 CREATE_COLLECTION_FROM_QUERY Procedure............................................................ 5-18 5.31 CREATE_COLLECTION_FROM_QUERY2 Procedure.......................................................... 5-19 5.32 CREATE_COLLECTION_FROM_QUERY_B Procedure ....................................................... 5-21 5.33 CREATE_COLLECTION_FROM_QUERY_B Procedure (No bind version) ....................... 5-22 5.34 CREATE_COLLECTION_FROM_QUERYB2 Procedure ....................................................... 5-23 5.35 CREATE_COLLECTION_FROM_QUERYB2 Procedure (No bind version) ....................... 5-25 5.36 DELETE_ALL_COLLECTIONS Procedure .............................................................................. 5-26 5.37 DELETE_ALL_COLLECTIONS_SESSION Procedure............................................................ 5-27 5.38 DELETE_COLLECTION Procedure .......................................................................................... 5-28 5.39 DELETE_MEMBER Procedure ................................................................................................... 5-29 5.40 DELETE_MEMBERS Procedure ................................................................................................. 5-29 5.41 GET_MEMBER_MD5 Function .................................................................................................. 5-30 5.42 MERGE_MEMBERS Procedure .................................................................................................. 5-31 5.43 MOVE_MEMBER_DOWN Procedure....................................................................................... 5-33 5.44 MOVE_MEMBER_UP Procedure............................................................................................... 5-34 5.45 RESEQUENCE_COLLECTION Procedure............................................................................... 5-35 5.46 RESET_COLLECTION_CHANGED Procedure ...................................................................... 5-36 5.47 RESET_COLLECTION_CHANGED_ALL Procedure ............................................................ 5-36 5.48 SORT_MEMBERS Procedure ...................................................................................................... 5-37 5.49 TRUNCATE_COLLECTION Procedure ................................................................................... 5-37 5.50 UPDATE_MEMBER Procedure.................................................................................................. 5-38 5.51 UPDATE_MEMBERS Procedure................................................................................................ 5-40

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download