1 PACKAGE FND_FLEX_APIS AS
2 /* $Header: AFFFAPIS.pls 120.1.12010000.1 2008/07/25 14:13:36 appldev ship $ */
3
4 -- ------------------------------------------------------------------------
5 -- Gets the segment number corresponding to the **UNIQUE** qualifier
6 -- name entered. Segment number is the display order of the segment
7 -- not to be confused with the SEGMENT_NUM column of the
8 -- FND_ID_FLEX_SEGMENTS table. Returns TRUE segment_number if ok,
9 -- or FALSE and sets error using FND_MESSAGES on error.
10 -- ------------------------------------------------------------------------
11 FUNCTION get_qualifier_segnum(appl_id IN NUMBER,
12 key_flex_code IN VARCHAR2,
13 structure_number IN NUMBER,
14 flex_qual_name IN VARCHAR2,
15 segment_number OUT nocopy NUMBER)
16 RETURN BOOLEAN;
17 PRAGMA RESTRICT_REFERENCES(get_qualifier_segnum, WNDS, WNPS);
18
19
20 -- ----------------------------------------------------------------------
21 FUNCTION get_segment_column(x_application_id in NUMBER,
22 x_id_flex_code in VARCHAR2,
23 x_id_flex_num in NUMBER,
24 x_seg_attr_type in VARCHAR2,
25 x_app_column_name in out nocopy VARCHAR2)
26 RETURN BOOLEAN;
27 PRAGMA RESTRICT_REFERENCES(get_segment_column, WNDS, WNPS);
28
29 -- ----------------------------------------------------------------------
30 FUNCTION get_segment_info(x_application_id in NUMBER,
31 x_id_flex_code in VARCHAR2,
32 x_id_flex_num in NUMBER,
33 x_seg_num in NUMBER,
34 x_appcol_name out nocopy VARCHAR2,
35 x_seg_name out nocopy VARCHAR2,
36 x_prompt out nocopy VARCHAR2,
37 x_value_set_name out nocopy VARCHAR2)
38 RETURN BOOLEAN;
39 PRAGMA RESTRICT_REFERENCES(get_segment_info, WNDS, WNPS);
40
41
42 -- ----------------------------------------------------------------------
43 FUNCTION get_enabled_segment_num(x_application_id in NUMBER,
44 x_conc_prog_name in VARCHAR2,
45 x_num_of_segments out nocopy NUMBER)
46 return BOOLEAN;
47 PRAGMA RESTRICT_REFERENCES(get_enabled_segment_num, WNDS, WNPS);
48
49 -- ----------------------------------------------------------------------
50 FUNCTION get_segment_delimiter(x_application_id in NUMBER,
51 x_id_flex_code in VARCHAR2,
52 x_id_flex_num in NUMBER)
53 return VARCHAR2;
54 PRAGMA RESTRICT_REFERENCES(get_segment_delimiter, WNDS, WNPS);
55
56 -- ----------------------------------------------------------------------
57 FUNCTION gbl_get_segment_delimiter(x_application_id in NUMBER,
58 x_id_flex_code in VARCHAR2,
59 x_id_flex_num in NUMBER)
60 return VARCHAR2;
61 PRAGMA RESTRICT_REFERENCES(gbl_get_segment_delimiter, WNDS, WNPS);
62
63 -- ----------------------------------------------------------------------
64 FUNCTION is_descr_setup(x_application_id in NUMBER,
65 x_desc_flex_name in VARCHAR2)
66 return BOOLEAN;
67 PRAGMA RESTRICT_REFERENCES(is_descr_setup, WNDS, WNPS);
68
69 -- ----------------------------------------------------------------------
70 FUNCTION gbl_is_descr_setup(x_application_id in NUMBER,
71 x_desc_flex_name in VARCHAR2)
72 return BOOLEAN;
73 PRAGMA RESTRICT_REFERENCES(gbl_is_descr_setup, WNDS, WNPS);
74
75 -- ----------------------------------------------------------------------
76 FUNCTION is_descr_required(x_application_id in NUMBER,
77 x_desc_flex_name in VARCHAR2)
78 return BOOLEAN;
79 PRAGMA RESTRICT_REFERENCES(is_descr_required, WNDS, WNPS);
80
81 -- ----------------------------------------------------------------------
82 PROCEDURE descr_setup_or_required(x_application_id IN NUMBER,
83 x_desc_flex_name IN VARCHAR2,
84 enabled_flag OUT nocopy VARCHAR2,
85 required_flag OUT nocopy VARCHAR2);
86 PRAGMA RESTRICT_REFERENCES(descr_setup_or_required, WNDS, WNPS);
87
88 -- ----------------------------------------------------------------------
89 PROCEDURE gbl_descr_setup_or_required(x_application_id IN NUMBER,
90 x_desc_flex_name IN VARCHAR2,
91 enabled_flag OUT nocopy VARCHAR2,
92 required_flag OUT nocopy VARCHAR2);
93 PRAGMA RESTRICT_REFERENCES(gbl_descr_setup_or_required, WNDS, WNPS);
94
95 -- ----------------------------------------------------------------------
96 TYPE varchar2_table IS TABLE OF VARCHAR2(32000) INDEX BY BINARY_INTEGER;
97
98 --
99 -- Stores the count and the names of required segments of a given DFF context.
100 -- Segment names are stored in 1 based array. (1 <= i <= required_segment_count)
101 --
102 TYPE dff_required_segments_info IS RECORD
103 (context_code fnd_descr_flex_contexts.descriptive_flex_context_code%TYPE,
104 required_segment_names varchar2_table,
105 required_segment_count NUMBER);
106
107 -- ----------------------------------------------------------------------
108 -- Gets the required segment information for global segments of a given descriptive flexfield.
109 --
110 -- p_application_id - Application id of the DFF.
111 -- p_flexfield_name - Name of the DFF.
112 -- x_is_context_segment_required - Whether or not the context segment is required.
113 -- x_global_req_segs_info - Information about global required segments.
114 -- ----------------------------------------------------------------------
115 PROCEDURE get_dff_global_req_segs_info(p_application_id IN NUMBER,
116 p_flexfield_name IN VARCHAR2,
117 x_is_context_segment_required OUT nocopy BOOLEAN,
118 x_global_req_segs_info OUT nocopy dff_required_segments_info);
119
120 -- ----------------------------------------------------------------------
121 -- Gets the required segment information for a context of a given descriptive flexfield.
122 --
123 -- p_application_id - Application id of the DFF.
124 -- p_flexfield_name - Name of the DFF.
125 -- p_context_code - Internal code of the context value.
126 -- x_context_req_segs_info - Information about context sensitive required segments.
127 -- ----------------------------------------------------------------------
128 PROCEDURE get_dff_context_req_segs_info(p_application_id IN NUMBER,
129 p_flexfield_name IN VARCHAR2,
130 p_context_code IN VARCHAR2,
131 x_context_req_segs_info OUT nocopy dff_required_segments_info);
132
133 END FND_FLEX_APIS;
[Home] [Help]