DBA Data[Home] [Help]

PACKAGE: APPS.XNP_WSGL

Source


1 package XNP_wsgl AUTHID CURRENT_USER as
2 /* $Header: XNPWSGLS.pls 120.2 2006/02/13 07:58:58 dputhiye ship $ */
3 
4 
5 --------------------------------------------------------------------------------
6 -- Declare constants for use in Layout procedures
7    LAYOUT_TABLE      constant number(1) := 1;
8    LAYOUT_PREFORMAT  constant number(1) := 2;
9    LAYOUT_BULLET     constant number(1) := 3;
10    LAYOUT_NUMBER     constant number(1) := 4;
11    LAYOUT_CUSTOM     constant number(1) := 5;
12    LAYOUT_WRAP       constant number(1) := 6;
13 
14    MENU_LONG         constant number(1) := 1;
15    MENU_SHORT        constant number(1) := 2;
16 
17    TYPE_CHAR         constant number(1) := 1;
18    TYPE_CHAR_UPPER   constant number(1) := 2;
19    TYPE_DATE         constant number(1) := 3;
20    TYPE_NUMBER       constant number(1) := 4;
21 
22 --------------------------------------------------------------------------------
23 -- Declare constant for Max number of rows which can be returned
24    MAX_ROWS          constant number(4) := 1000;
25 
26 --------------------------------------------------------------------------------
27 -- Declare types used in Domain Validation
28 
29    DV_TEXT     constant number(1) := 1;
30    DV_CHECK    constant number(1) := 2;
31    DV_RADIO    constant number(1) := 3;
32    DV_LIST     constant number(1) := 4;
33 
34    type typString240Table is table of varchar2(240)
35                           index by binary_integer;
36 
37    type typDVRecord is record
38         (ColAlias    varchar2(30) := null,
39          Initialised boolean      := false,
40          ControlType number(1)    := DV_TEXT,
41          DispWidth   number(5)    := 30,
42          DispHeight  number(5)    := 1,
43          MaxWidth    number(5)    := 30,
44          UseMeanings boolean      := false,
45          ColOptional boolean      := false,
46          NumOfVV     integer      := 0,
47          Vals typString240Table,
48          Meanings typString240Table,
49          Abbreviations typString240Table);
50 
51    EmptyStringTable  typString240Table;
52 --------------------------------------------------------------------------------
53 -- Declare types used in building controls
54    CTL_READONLY     constant number(1) := 1;
55    CTL_UPDATABLE    constant number(1) := 2;
56    CTL_INSERTABLE   constant number(1) := 3;
57    CTL_QUERY        constant number(1) := 4;
58 
59 --------------------------------------------------------------------------------
60 -- Declare constants for form status
61    FORM_STATUS_OK      constant number(1) := 0;
62    FORM_STATUS_ERROR   constant number(1) := 1;
63    FORM_STATUS_INS     constant number(1) := 2;
64    FORM_STATUS_UPD     constant number(1) := 3;
65 
66 --------------------------------------------------------------------------------
67 -- Declare constants message types
68    MESS_INFORMATION    constant number(1) := 1;
69    MESS_SUCCESS        constant number(1) := 2;
70    MESS_WARNING        constant number(1) := 3;
71    MESS_ERROR          constant number(1) := 4;
72    MESS_ERROR_QRY      constant number(1) := 5;
73    MESS_EXCEPTION      constant number(1) := 6;
74 
75 --------------------------------------------------------------------------------
76 -- Declare WebServer Generator Library procedures and functions
77 
78    function IsSupported (feature in varchar2) return boolean;
79 
80    procedure LayoutOpen(p_layout_style in number,
81                         p_border in boolean default false,
82                         p_custom_bullet in varchar2 default null);
83 
84    procedure LayoutClose;
85 
86    procedure LayoutRowStart(p_valign in varchar2 default null);
87 
88    procedure LayoutRowEnd;
89 
90    procedure LayoutHeader(p_width in number,
91                           p_align in varchar2,
92                           p_title in varchar2);
93 
94    procedure LayoutData(p_text in varchar2);
95    procedure LayoutData(p_date in date);
96    procedure LayoutData(p_number in number);
97 
98    procedure DefinePageHead(p_title in varchar2 default null,
99                             p_bottomframe in boolean default false);
100 
101    procedure OpenPageHead(p_title in varchar2 default null,
102                           p_bottomframe in boolean default false);
103 
104    procedure ClosePageHead;
105 
106    procedure OpenPageBody(p_center in boolean default false,
107                           p_attributes in varchar2 default null);
108 
109    procedure ClosePageBody;
110 
111    function  InBottomFrame return boolean;
112 
113    function  Preformat(p_text in varchar2) return varchar2;
114 
115    procedure DefaultPageCaption(p_caption in varchar2 default null,
116                                 p_headlevel in number default null);
117 
118    procedure BuildWhere(p_field1   in varchar2,
119                         p_field2   in varchar2,
120                         p_sli      in varchar2,
121                         p_datatype in number,
122                         p_where    in OUT NOCOPY varchar2,
123                         p_date_format in varchar2 default null);
124 
125    procedure BuildWhere(p_field    in varchar2,
126                         p_sli      in varchar2,
127                         p_datatype in number,
128                         p_where    in OUT NOCOPY varchar2,
129                         p_date_format in varchar2 default null,
130                         p_caseinsensitive in boolean default true);
131 
132    procedure BuildWhere(p_field    in typString240Table,
133                         p_sli      in varchar2,
134                         p_datatype in number,
135                         p_where    in OUT NOCOPY varchar2,
136                         p_date_format in varchar2 default null);
137 
138    function SearchComponents(p_search in varchar2,
139                              p_uu in OUT NOCOPY varchar2,
140                              p_ul in OUT NOCOPY varchar2,
141                              p_lu in OUT NOCOPY varchar2,
142                              p_ll in OUT NOCOPY varchar2) return number;
143 
144    procedure NavLinks(p_style in number default null,
145                       p_caption in varchar2 default null,
146                       p_menu_level in number default 0,
147                       p_proc in varchar2 default null,
148                       p_target in varchar2 default '_top');
149 
150    function  TablesSupported return boolean;
151 
152    procedure Info(p_full in boolean default true,
153                   p_app in varchar2 default null,
154                   p_mod in varchar2 default null);
155 
156    procedure EmptyPage(p_attributes in varchar2 default null);
157    function  EmptyPageURL(p_attributes in varchar2 default null) return varchar2;
158 
159    procedure SubmitButton(p_name in varchar2,
160                           p_title in varchar2,
161                           p_type in varchar2,
162                           buttonJS in varchar2 default null);
163 
164    procedure RecordListButton(p_reqd in boolean,
165                   p_name in varchar2,
166                               p_title in varchar2,
167                               p_mess in varchar2 default null,
168                   p_dojs in boolean default false,
169             buttonJS in varchar2 default null
170                   );
171 
172    function  CountHits(
173              P_SQL in varchar2) return number;
174 
175    procedure LoadDomainValues(
176              P_REF_CODE_TABLE in varchar2,
177              P_DOMAIN in varchar2,
178              P_DVREC in OUT NOCOPY typDVRecord);
179 
180    function ValidDomainValue(
181             P_DVREC in typDVRecord,
182             P_VALUE in OUT NOCOPY varchar2) return boolean;
183 
184    function DomainMeaning(
185             P_DVREC in typDVRecord,
186             P_VALUE in varchar2) return varchar2;
187 
188    function DomainValue(
189             P_DVREC in typDVRecord,
190             P_MEANING in varchar2) return varchar2;
191 
192    function DomainValue(
193             P_DVREC in typDVRecord,
194             P_MEANING in typString240Table) return typString240Table;
195 
196    function BuildDVControl(
197             P_DVREC in typDVRecord,
198             P_CTL_STYLE in number,
199             P_CURR_VAL in varchar2 default null,
200             p_onclick in boolean default false,
201             p_onchange in boolean default false,
202             p_onblur in boolean default false,
203             p_onfocus in boolean default false,
204             p_onselect in boolean default false) return varchar2;
205 
206    function BuildTextControl(
207             p_alias in varchar2,
208             p_size in varchar2 default null,
209             p_height in varchar2 default null,
210             p_maxlength in varchar2 default null,
211             p_value in varchar2 default null,
212             p_onclick in boolean default false,
213             p_onchange in boolean default false,
214             p_onblur in boolean default false,
215             p_onfocus in boolean default false,
216             p_onselect in boolean default false) return varchar2;
217 
218    function BuildQueryControl(
219             p_alias in varchar2,
220             p_size in varchar2 default null,
221             p_range in boolean default false,
222             p_onclick in boolean default false,
223             p_onchange in boolean default false,
224             p_onblur in boolean default false,
225             p_onfocus in boolean default false,
226             p_onselect in boolean default false) return varchar2;
227 
228    function BuildDerivationControl(p_name in varchar2,
229                                    p_size in varchar2,
230                                    p_value in varchar2,
231                                    p_onclick in boolean default false,
232                                    p_onblur in boolean default false,
233                                    p_onfocus in boolean default false,
234                                    p_onselect in boolean default false) return varchar2;
235 
236    procedure HiddenField(p_paramname in varchar2,
237                          p_paramval in varchar2);
238 
239    procedure HiddenField(p_paramname in varchar2,
240                          p_paramval in typString240Table);
241 
242    procedure DisplayMessage(p_type in number,
243                             p_mess in varchar2,
244                             p_title in varchar2 default null,
245                             p_attributes in varchar2 default null,
246                             p_location in varchar2 default null,
247                             p_context in varchar2 default null,
248                             p_action in varchar2 default null);
249 
250    procedure StoreErrorMessage(p_mess in varchar2);
251 
252    function MsgGetText(p_MsgNo in number,
253                        p_DfltText in varchar2 default null,
254                        p_Subst1 in varchar2 default null,
255                        p_Subst2 in varchar2 default null,
256                        p_Subst3 in varchar2 default null,
257                        p_LangId in number default null) return varchar2;
258 
259    function EscapeURLParam(p_param in varchar2 ) return varchar2;
260 
261    function GetUser return varchar2;
262 --   pragma restrict_references(GetUser, WNDS, WNPS);
263 
264    procedure RegisterURL(p_url in varchar2);
265 
266    procedure AddURLParam(p_paramname in varchar2,
267                          p_paramval in varchar2);
268 
269    procedure AddURLParam(p_paramname in varchar2,
270                          p_paramval in typString240Table);
271 
272    procedure RefreshURL;
273 
274    function NotLowerCase return boolean;
275 
276    function ExternalCall(p_proc in varchar2) return boolean;
277 
278    function CalledDirect(p_proc in varchar2) return boolean;
279 
280    procedure StoreURLLink(p_level in number,
281                           p_caption in varchar2,
282                           p_open in boolean default true,
283                           p_close in boolean default true);
284 
285    procedure ReturnLinks(p_levels in varchar2, p_style in number);
286 
287    function Checksum(p_buff in varchar2) return number;
288    function ValidateChecksum(p_buff in varchar2, p_checksum in varchar2) return boolean;
289 
290    -- R2.1 Backward compatibility
291    function EscapeURLParam(p_param in varchar2,
292                            p_space in boolean default true,
293                            p_plus in boolean default true,
294                            p_percent in boolean,
295                            p_doublequote in boolean default true,
296                            p_hash in boolean default true,
297                            p_ampersand in boolean ) return varchar2;
298 
299 
300    -- R1.3 Backward compatibility
301    procedure RowContext(p_context in varchar2);
302 
303    procedure PageHeader(p_title in varchar2,
304                         p_header in varchar2,
305                         p_background in varchar2 default null,
306                         p_center in boolean default false);
307 
308    procedure PageFooter;
309 
310    function  MAX_ROWS_MESSAGE return varchar2;
311 
312 end;