1 PACKAGE hr_update_utility AUTHID CURRENT_USER AS
2 /* $Header: hruptutil.pkh 115.5 2004/04/05 02:57:51 mbocutt noship $ */
3
4 -- ----------------------------------------------------------------------------
5 -- |----------------------------< submitRequest >-----------------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 --
9 -- Description:
10 -- This procedure submits a concurrent request from within a patch. The
11 -- request will be processed when the concurrent managers restart after
12 -- completion of the apps-wide downtime window.
13 --
14 -- The package function identified by the p_validate_function parameter is
15 -- called to determine whether there is any data to be updated. If no data
16 -- is present for update then the called function should return FALSE and the
17 -- concurrent request is not submitted. If data is present for update then
18 -- the function should return TRUE and the concurrent request will be
19 -- submitted.
20 --
21 -- Prerequisites
22 --
23 -- Parameters:
24 -- Name Reqd Type Description
25 -- p_app_shortname Y Varchar2 The shortname of the app that
26 -- owns the request being
27 -- submitted.
28 -- p_update_name Y Varchar2 The name of the update to be
29 -- processed.
30 -- p_validate_proc Y Varchar2 The name of a procedure called
31 -- to determine whether the
32 -- update being submitted is
33 -- required.
34 -- p_business_group_Id N Number Business group ID
35 -- p_legislation_code N Varchar2 Legislation code for BG
36 -- specified
37 -- p_argument1..10 N Varchar2 Optional parameters to pass
38 -- to conc request.
39 --
40 procedure submitRequest
41 (p_app_shortname in varchar2
42 ,p_update_name in varchar2
43 ,p_validate_proc in varchar2
44 ,p_business_group_id in number default null
45 ,p_legislation_code in varchar2 default null
46 ,p_argument1 in varchar2 default chr(0)
47 ,p_argument2 in varchar2 default chr(0)
48 ,p_argument3 in varchar2 default chr(0)
49 ,p_argument4 in varchar2 default chr(0)
50 ,p_argument5 in varchar2 default chr(0)
51 ,p_argument6 in varchar2 default chr(0)
52 ,p_argument7 in varchar2 default chr(0)
53 ,p_argument8 in varchar2 default chr(0)
54 ,p_argument9 in varchar2 default chr(0)
55 ,p_argument10 in varchar2 default chr(0)
56 ,p_request_id out nocopy number);
57
58
59 -- ----------------------------------------------------------------------------
60 -- |--------------------------< isUpdateComplete >----------------------------|
61 -- ----------------------------------------------------------------------------
62 --
63 --
64 -- Description:
65 -- This function can be called from a function(Form, web-page or conc
66 -- request) to determine whether the update it is dependent upon has
67 -- completed successfully. If the named upgrade has completed then TRUE
68 -- is returned otherwise FALSE is returned.
69 --
70 -- This function utilises the PAY_UPGRADE_DEFINITIONS and PAY_UPGRADE_STATUS
71 --
72 --
73 -- Prerequisites
74 --
75 -- Parameters:
76 -- Name Reqd Type Description
77 -- p_app_shortname Y Varchar2 The shortname of the app
78 -- p_function_name Y Varchar2 The name of the function.
79 -- p_business_group_id Y Number The ID if the sessions BG.
80 -- p_update_name Y Varchar2 The name of the update which
81 -- this function is dependent
82 -- upon.
83 --
84 function isUpdateComplete
85 (p_app_shortname varchar2
86 ,p_function_name varchar2
87 ,p_business_group_id number
88 ,p_update_name varchar2) return varchar2;
89
90 -- ----------------------------------------------------------------------------
91 -- |---------------------------< setUpdateComplete >--------------------------|
92 -- ----------------------------------------------------------------------------
93 --
94 --
95 -- Description:
96 -- This procedure can be called from the end of an update job
97 -- to set the status of the Job to "Complete" in the PAY_UPGRADE_STATUS
98 -- table. This should be the final step of the upgrade process.
99 --
100 -- Prerequisites
101 --
102 -- Parameters:
103 -- Name Reqd Type Description
104 -- p_update_name Y Varchar2 The name of the update.
105 -- p_business_group_id N Number Business group id.
106 -- p_legislation_code N Number Legislation code.
107 --
108 procedure setUpdateComplete
109 (p_update_name varchar2,
110 p_business_group_id number default null,
111 p_legislation_code varchar2 default null) ;
112
113 -- ----------------------------------------------------------------------------
114 -- |---------------------------< setUpdateProcessing >------------------------|
115 -- ----------------------------------------------------------------------------
116 --
117 --
118 -- Description:
119 -- This procedure can be called from the start of an update job
120 -- to set the status of the Job to "Processing" in the PAY_UPGRADE_STATUS
121 -- table. This should be the first step of the upgrade process.
122 --
123 -- Prerequisites
124 --
125 -- Parameters:
126 -- Name Reqd Type Description
127 -- p_update_name Y Varchar2 The name of the update.
128 -- p_business_group_id N Number Business group id.
129 -- p_legislation_code N Number Legislation code.
130 --
131 procedure setUpdateProcessing
132 (p_update_name varchar2,
133 p_business_group_id number default null,
134 p_legislation_code varchar2 default null) ;
135
136
137 end hr_update_utility;
[Home] [Help]