44.3 データ型
この項では、APEX_PLUGIN
パッケージで使用するデータ型について説明します。
- c_inline_in_notification
- c_inline_with_field
- c_inline_with_field_and_notif
- c_on_error_page
- t_authentication
- t_authentication_ajax_result
- t_authentication_auth_result
- t_authentication_inval_result
- t_authentication_logout_result
- t_authentication_sentry_result
- t_authorization
- t_authorization_exec_result
- t_dynamic_action
- t_dynamic_action_ajax_result
- t_dynamic_action_render_result
- t_escape_mode
- t_item
- t_item_ajax_result
- t_item_meta_data_result
- t_item_render_param
- t_item_render_result
- t_item_validation_result
- t_plugin
- t_plugin_attributes
- t_process
- t_process_exec_result
- t_region
- t_region_ajax_result
- t_region_column
- t_region_columns
- t_region_render_param
- t_region_render_result
- t_remote_server_config
- t_remote_server_info
親トピック: APEX_PLUGIN
44.3.1 c_inline_in_notification
次の定数は、ページ・アイテム検証ファンクションの結果の型t_page_item_validation_result
のdisplay_location
で使用します。
c_inline_in_notification constant varchar2(40) := 'INLINE_IN_NOTIFICATION';
親トピック: データ型
44.3.2 c_inline_with_field
定数c_inline_with_field
は、ページ・アイテム検証ファンクションの結果の型t_page_item_validation_result
のdisplay_location
で使用します。
c_inline_with_field constant varchar2(40) := 'INLINE_WITH_FIELD';
親トピック: データ型
44.3.3 c_inline_with_field_and_notif
定数c_inline_with_field_and_notif
は、ページ・アイテム検証ファンクションの結果の型t_page_item_validation_result
のdisplay_location
で使用します。
c_inline_with_field_and_notif constant varchar2(40) := 'INLINE_WITH_FIELD_AND_NOTIFICATION';
親トピック: データ型
44.3.4 c_on_error_page
定数c_on_error_page
は、ページ・アイテム検証ファンクションの結果の型t_page_item_validation_result
のdisplay_location
で使用します。
c_on_error_page constant varchar2(40) := 'ON_ERROR_PAGE';
親トピック: データ型
44.3.5 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) );
親トピック: データ型
44.3.6 t_authentication_ajax_result
type t_authentication_ajax_result is record (
dummy boolean );
親トピック: データ型
44.3.7 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) );
親トピック: データ型
44.3.8 t_authentication_inval_result
type t_authentication_inval_result is record (
redirect_url varchar2(4000) );
親トピック: データ型
44.3.9 t_authentication_logout_result
type t_authentication_logout_result is record (
redirect_url varchar2(4000) );
親トピック: データ型
44.3.10 t_authentication_sentry_result
type t_authentication_sentry_result is record (
is_valid boolean );
親トピック: データ型
44.3.11 t_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),
親トピック: データ型
44.3.12 t_authorization_exec_result
t_authorization_exec_result
データ型は、APEX_PLUGIN
パッケージに追加されています。
type t_authorization_exec_result is record (
is_authorized boolean
);
親トピック: データ型
44.3.13 t_dynamic_action
t_dynamic_action
型は、すべての動的アクションのプラグイン・ファンクションに渡され、現在の動的アクションに関する情報が含まれます。
type t_dynamic_action is record (
id number,
name varchar2(255)
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),
init_javascript_code varchar2(32767),
triggering_region_id number,
affected_elements_type varchar2(30),
affected_region_id number,
affected_button_id number,
affected_elements varchar2(4000) );
親トピック: データ型
44.3.14 t_dynamic_action_ajax_result
t_dynamic_action_ajax_result
型は、動的アクション・タイプ・プラグインのAjaxファンクションで結果の型として使用されます。
type t_dynamic_action_ajax_result is record (
dummy boolean /* not used yet */
);
親トピック: データ型
44.3.15 t_dynamic_action_render_result
t_dynamic_action_render_result
型は、動的アクション・プラグインのレンダリング・ファンクションで結果の型として使用されます。
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) );
親トピック: データ型
44.3.16 t_escape_mode
置換変数をエスケープするためのモード。
subtype t_escape_mode is pls_integer range 1..6;
c_escape_mode_raw constant t_escape_mode := 1;
c_escape_mode_html constant t_escape_mode := 2;
c_escape_mode_html_attribute constant t_escape_mode := 3;
c_escape_mode_javascript constant t_escape_mode := 4;
c_escape_mode_striphtml constant t_escape_mode := 5;
c_escape_mode_json constant t_escape_mode := 6;
親トピック: データ型
44.3.17 t_item
t_item
型は、すべてのアイテム・タイプのプラグイン・ファンクションに渡され、現在のページ・アイテムに関する情報が含まれます。
type t_item is record (
id NUMBER,
name VARCHAR2(4000),
session_state_name VARCHAR2(4000),
component_type_id NUMBER,
region_id NUMBER,
form_region_id NUMBER,
data_type VARCHAR2(32767),
source_data_type apex_exec_api.t_data_type,
session_state_data_type apex_session_state_api.t_data_type,
multi_value_type apex_exec_api.t_multi_value_type,
multi_value_separator VARCHAR2(10),
label VARCHAR2(4000),
plain_label VARCHAR2(4000),
label_id VARCHAR2(4000),
placeholder VARCHAR2(4000),
format_mask VARCHAR2(4000),
is_required BOOLEAN,
lov_type VARCHAR2(4000),
lov_definition VARCHAR2(4000),
lov_language apex_code_exec.t_language,
shared_lov_id NUMBER,
lov_display_extra BOOLEAN,
lov_display_null BOOLEAN,
lov_null_text VARCHAR2(4000),
lov_null_value VARCHAR2(4000),
lov_cascade_parent_items VARCHAR2(4000),
lov_return_column VARCHAR2(128),
lov_display_column VARCHAR2(128),
lov_icon_column VARCHAR2(128),
lov_group_column VARCHAR2(128),
lov_group_sort_direction VARCHAR2(16),
lov_default_sort_column VARCHAR2(128),
lov_default_sort_direction VARCHAR2(16),
lov_oracle_text_column VARCHAR2(128),
lov_columns t_lov_columns,
lov_is_legacy BOOLEAN,
ajax_items_to_submit VARCHAR2(4000),
ajax_optimize_refresh BOOLEAN,
element_width NUMBER,
element_max_length NUMBER,
element_height NUMBER,
element_css_classes VARCHAR2(4000),
element_attributes VARCHAR2(4000),
element_option_attributes VARCHAR2(4000),
icon_css_classes VARCHAR2(4000),
escape_output BOOLEAN,
ignore_change BOOLEAN DEFAULT TRUE,
--
attributes apex_t_plugin_attributes,
--
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),
init_javascript_code VARCHAR2(32767),
inline_help_text VARCHAR2(4000),
inline_help_id VARCHAR2(270),
);
親トピック: データ型
44.3.18 t_item_ajax_result
t_item_ajax_result
型は、アイテム・タイプ・プラグインのAjaxファンクションで結果の型として使用されます。
type t_item_ajax_result is record (
dummy boolean /* not used yet */
);
親トピック: データ型
44.3.19 t_item_meta_data_result
t_item_meta_data_result
型は、アイテム・タイプのプラグインのメタデータ・ファンクションの結果の型として使用されます。
構文
TYPE T_ITEM_META_DATA_RESULT IS RECORD (
is_multi_value BOOLEAN DEFAULT FALSE, /* (Deprecated) Declare if multiple values can be selected
in an LOV-based item plug-in */
display_lov_definition VARCHAR2(32767), /* Provides the lov definition (SQL-statement) to the
interactive grid */
return_display_value BOOLEAN DEFAULT TRUE, /* Declare if item plug-in has a display and return
value or just a return value */
escape_output BOOLEAN DEFAULT TRUE, /* Declare if output should be escaped or not e.g. in
Interactive Grid. Used for HTML Markup based items
like an image item plug-in */
container_css_classes VARCHAR2(32767) /* Add CSS classes on container level for an item plug-in */
);
親トピック: データ型
44.3.20 t_item_render_param
t_item_render_paramタイプは、アイテム・タイプのプラグインのレンダリング・プロシージャに渡され、現在のページ・アイテム値に関する情報が含まれています。
type t_item_render_param is record (
value_set_by_controller BOOLEAN DEFAULT FALSE,
value VARCHAR2(32767),
clob_value CLOB,
is_readonly BOOLEAN DEFAULT FALSE,
is_printer_friendly BOOLEAN DEFAULT FALSE
);
親トピック: データ型
44.3.21 t_item_render_result
t_item_render_result
型は、アイテム・タイプ・プラグインのレンダリング・ファンクションで結果の型として使用されます。
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 */
item_rendered boolean default true /* should be set to false if the render procedure didn't render anything,
this could be the case for a read only item in IG */
);
親トピック: データ型
44.3.22 t_item_validation_result
t_item_validation_result
型は、アイテム・タイプ・プラグインの検証ファンクションで結果の型として使用されます。
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 */
親トピック: データ型
44.3.23 t_plugin
t_plugin
型は、すべてのプラグイン・ファンクションに渡され、現在のプラグインに関する情報が含まれます。type t_plugin is record (
name varchar2(45),
file_prefix varchar2(4000),
attributes t_plugin_attributes, /* used by region and item plug-ins */
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) );
親トピック: データ型
44.3.24 t_plugin_attributes
type t_plugin_attributes is object (
function get_varchar2 (
p_static_id IN VARCHAR2
--
p_default_value IN VARCHAR2 DEFAULT NULL,
p_do_substitutions IN BOOLEAN DEFAULT FALSE,
p_do_serveronly_substitutions IN BOOLEAN DEFAULT FALSE,
p_substitutions_escape_mode IN apex_session_state.t_escape_mode
DEFAULT apex_session_state.c_escape_mode_html )
RETURN VARCHAR2
-–
function get_number (
p_static_id IN VARCHAR2,
--
p_default_value IN NUMBER DEFAULT NULL )
RETURN NUMBER
–-Y returns TRUE / N returns FALSE
function get_boolean (
p_static_id IN VARCHAR2,
--
p_default_value IN BOOLEAN DEFAULT NULL )
RETURN BOOLEAN
);
ノート:
パラメータp_do_substitutions
およびp_do_serveronly_substitutions
は、同じファンクション・コールでは使用できません。
親トピック: データ型
44.3.25 t_process
t_process
型は、すべてのプロセス・タイプのプラグイン・ファンクションに渡され、現在のプロセスに関する情報が含まれます。
type t_process is record (
id number,
name varchar2(255),
region_id number,
row_num number,
correlation_context varchar2(4000),
component_type varchar2(30),
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) );
親トピック: データ型
44.3.26 t_process_exec_result
t_process_exec_result
型は、プロセス・タイプ・プラグインの実行ファンクションで結果の型として使用されます。
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 */
);
親トピック: データ型
44.3.27 t_region
t_region
型は、すべてのリージョン・タイプのプラグイン・ファンクションに渡され、現在のリージョンに関する情報が含まれます。
type t_region is record (
id NUMBER,
static_id VARCHAR2(255),
name VARCHAR2(4000),
title VARCHAR2(4000),
type VARCHAR2(255),
source VARCHAR2(32767),
lazy_loading BOOLEAN,
ajax_items_to_submit VARCHAR2(32767),
ajax_items_to_submit_singlerow VARCHAR2 (32767),
fetched_rows PLS_INTEGER,
escape_output BOOLEAN,
error_message VARCHAR2(32767), /* obsolete */
no_data_found_message VARCHAR2(32767),
attributes t_plugin_attributes, /* only used by region plug-ins */
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),
filter_region_id NUMBER,
filter_region_static_id VARCHAR2(255),
region_columns t_region_columns,
init_javascript_code VARCHAR2(32767) );
親トピック: データ型
44.3.28 t_region_ajax_result
t_region_ajax_result
型は、リージョン・タイプ・プラグインのAjaxファンクションで結果の型として使用されます。
type t_region_ajax_result is record (
dummy boolean /* not used yet */
);
親トピック: データ型
44.3.29 t_region_column
t_region_column
型は、すべてのリージョン・タイプのプラグイン・ファンクションに渡され、現在のリージョンに関する情報が含まれます。
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,
attributes t_plugin_attributes,
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);
親トピック: データ型
44.3.30 t_region_columns
type t_region_columns is table of t_region_column index by
pls_integer;
親トピック: データ型
44.3.31 t_region_render_param
type t_region_render_param is record (
is_printer_friendly boolean
);
親トピック: データ型
44.3.32 t_region_render_result
t_region_render_result
型は、リージョン・タイプ・プラグインのレンダリング・ファンクションで結果の型として使用されます。
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 */
);
親トピック: データ型
44.3.33 t_remote_server_config
フレキシブル・サーバーの構成プロシージャで使用されます。
type t_remote_server_config is record(
base_url varchar2(4000),
substitutions wwv_flow_t_varchar2 );
親トピック: データ型
44.3.34 t_remote_server_info
フレキシブル・サーバーの構成プロシージャで使用されます。
type t_remote_server_info is record(
application_id number,
remote_server_static_id varchar2(255) );
親トピック: データ型