28.1 Data Types
The data types used by the APEX_PLUGIN
package are described in this section.
Data Types:
c_*
The following constants are used for display_location
in the page item validation function result type t_page_item_validation_result
.
c_inline_with_field constant varchar2(40) := 'INLINE_WITH_FIELD'; c_inline_with_field_and_notif constant varchar2(40) := 'INLINE_WITH_FIELD_AND_NOTIFICATION'; c_inline_in_notification constant varchar2(40) := 'INLINE_IN_NOTIFICATION'; c_on_error_page constant varchar2(40) := 'ON_ERROR_PAGE';
t_authentication
type t_authentication is record ( id number, name varchar2(255), invalid_session_url varchar2(4000), logout_url varchar2(4000), plsql_code clob, attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767), -- session_id number, username varchar2(255) );
t_authentication_ajax_result
type t_authentication_ajax_result is record ( dummy boolean );
t_authentication_auth_result
type t_authentication_auth_result is record ( is_authenticated boolean, redirect_url varchar2(4000), log_code number, log_text varchar2(4000), display_text varchar2(4000) );
t_authentication_inval_result
type t_authentication_inval_result is record ( redirect_url varchar2(4000) );
t_authentication_logout_result
type t_authentication_logout_result is record ( redirect_url varchar2(4000) );
t_authentication_sentry_result
type t_authentication_sentry_result is record ( is_valid boolean );
t_authorization
The following type is passed to all authorization plug-in functions and contains information about the current authorization.
type t_authorization is record ( id number, name varchar2(255), username varchar2(255), caching varchar2(20), component apex.t_component, attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767),
t_authorization_exec_result
The t_authorization_exec_result
data type has been added to the APEX_PLUGIN
package.
type t_authorization_exec_result is record ( is_authorized boolean );
t_dynamic_action
The following type is passed into all dynamic action plug-in functions and contains information about the current dynamic action.
type t_dynamic_action is record ( id number, action varchar2(50), attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767) );
t_dynamic_action_ajax_result
The following type is used as the result type for the Ajax function of a dynamic action type plug-in.
type t_dynamic_action_ajax_result is record ( dummy boolean /* not used yet */ );
t_dynamic_action_render_result
The following type is used as the result type for the rendering function of a dynamic action plug-in.
type t_dynamic_action_render_result is record ( javascript_function varchar2(32767), ajax_identifier varchar2(255), attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767) );
t_item
The following type is passed into all item type plug-in functions and contains information about the current page item.
type t_item is record ( id number, name varchar2(255), label varchar2(4000), plain_label varchar2(4000), label_id varchar2(255), /* label id is set if 'Standard Form Element' = no and label template uses #LABEL_ID# substitution */ placeholder varchar2(255), format_mask varchar2(255), is_required boolean, lov_definition varchar2(4000), lov_display_extra boolean, lov_display_null boolean, lov_null_text varchar2(255), lov_null_value varchar2(255), lov_cascade_parent_items varchar2(255), ajax_items_to_submit varchar2(255), ajax_optimize_refresh boolean, element_width number, element_max_length number, element_height number, element_css_classes varchar2(255), element_attributes varchar2(2000), element_option_attributes varchar2(4000), escape_output boolean, attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767) );
t_item_ajax_result
The following type is used as the result type for the Ajax function of an item type plug-in.
type t_item_ajax_result is record ( dummy boolean /* not used yet */ );
t_item_render_param
The following type is used as the input type for the render procedure of an item type plug-in.
type t_item_render_param is record (
value_set_by_controller boolean default false,
value varchar2(32767),
is_readonly boolean default false,
is_printer_friendly boolean default false
);
t_item_render_result
The following type is used as the result type for the rendering function of an item type plug-in.
type t_item_render_result is record ( is_navigable boolean default false, navigable_dom_id varchar2(255) /* should only be set if navigable element is not equal to item name */ );
t_item_validation_result
The following type is used as the result type for the validation function of an item type plug-in.
type t_item_validation_result is record ( message varchar2(32767), display_location varchar2(40), /* if not set the application default is used */ page_item_name varchar2(255) ); /* if not set the validated page item name is used */
t_plugin
The following type is passed into all plug-in functions and contains information about the current plug-in.
type t_plugin is record ( name varchar2(45), file_prefix varchar2(4000), attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767) );
t_process
The following type is passed into all process type plug-in functions and contains information about the current process.
type t_process is record ( id number, name varchar2(255), success_message varchar2(32767), attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767) );
t_process_exec_result
The following type is used as the result type for the execution function of a process type plug-in.
type t_process_exec_result is record ( success_message varchar2(32767) execution_skipped boolean default false /* set to TRUE if process execution has been skipped by plug-in because of additional condition checks */ );
type t_region_column (
The following type is passed into all region type plug-in functions and contains information about the current region.
type t_region_column is record ( id number, name t_region_column_name, is_displayed boolean, heading apex_region_columns.heading%type, heading_alignment apex_region_columns.heading_alignment%type, value_alignment apex_region_columns.value_alignment%type, value_css_classes apex_region_columns.value_css_classes%type, value_attributes apex_region_columns.value_attributes%type, format_mask apex_region_columns.format_mask%type, escape_output boolean, attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767), attribute_16 varchar2(32767), attribute_17 varchar2(32767), attribute_18 varchar2(32767), attribute_19 varchar2(32767), attribute_20 varchar2(32767), attribute_21 varchar2(32767), attribute_22 varchar2(32767), attribute_23 varchar2(32767), attribute_24 varchar2(32767), attribute_25 varchar2(32767);
type t_region_columns is table of t_region_column index by pls_integer;
t_region
The following type is passed into all region type plug-in functions and contains information about the current region.
type t_region is record ( id number, static_id varchar2(255), name varchar2(255), type varchar2(255), source varchar2(32767), ajax_items_to_submit varchar2(32767), fetched_rows pls_integer, escape_output boolean, error_message varchar2(32767), /* obsolete */ no_data_found_message varchar2(32767), attribute_01 varchar2(32767), attribute_02 varchar2(32767), attribute_03 varchar2(32767), attribute_04 varchar2(32767), attribute_05 varchar2(32767), attribute_06 varchar2(32767), attribute_07 varchar2(32767), attribute_08 varchar2(32767), attribute_09 varchar2(32767), attribute_10 varchar2(32767), attribute_11 varchar2(32767), attribute_12 varchar2(32767), attribute_13 varchar2(32767), attribute_14 varchar2(32767), attribute_15 varchar2(32767), attribute_16 varchar2(32767), attribute_17 varchar2(32767), attribute_18 varchar2(32767), attribute_19 varchar2(32767), attribute_20 varchar2(32767), attribute_21 varchar2(32767), attribute_22 varchar2(32767), attribute_23 varchar2(32767), attribute_24 varchar2(32767), attribute_25 varchar2(32767), region_columns t_region_columns );
t_region_ajax_result
The following type is used as result type for the Ajax function of a region type plug-in.
type t_region_ajax_result is record ( dummy boolean /* not used yet */ );
t_region_render_result
The following type is used as the result type for the rendering function of a region type plug-in.
type t_region_render_result is record ( navigable_dom_id varchar2(255) /* can be used to put focus to an input field (that is, search field) the region renders as part of the plug-in output */ );
Parent topic: APEX_PLUGIN