1 Package hxc_approval_comps_api AUTHID CURRENT_USER as
2 /* $Header: hxchacapi.pkh 120.1 2006/06/08 15:54:21 gsirigin noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_approval_comps >-----------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
11 -- This API creates the Approval Components.
12 --
13 -- Prerequisites:
14 --
15 -- None.
16 --
17 -- In Parameters:
18 -- Name Reqd Type Description
19 --
20 -- p_validate No boolean If TRUE then the database
21 -- remains unchanged. If FALSE
22 -- then a new Approval Comp is
23 -- created. Default is FALSE.
24 -- p_approval_comp_id Yes number Primary Key for entity
25 -- p_approval_mechanism Yes varchar2 Approval Mechanism for the
26 -- Style
27 -- p_approval_style_id Yes number Approval Style ID
28 -- p_start_date Yes Date Start Date of the Approval
29 -- Components
30 -- p_end_date Yes Date End Date of the Approval
31 -- Components
32 -- p_time_recipient_id No number ID of the Application to
33 -- which the approval component
34 -- is applicable
35 -- p_approval_mechanism_id No number Approval_mechanism_id
36 -- corresponding to the approval
37 -- mechanism
38 -- p_approval_order No number The Sequence in which the
39 -- Approval Style is applicable
40 -- to the applications
41 -- p_wf_item_type No varchar2 WF_ITEM_TYPE of the workflow
42 -- p_wf_name No varchar2 Workflow Name
43 --
44 -- p_object_version_number No number Object Version Number
45 -- p_effective_date No date Effective date
46 --
47 -- Post Success:
48 --
49 -- The OUT PARAMETERS set,after the approval component has been created
50 -- successfully,are:
51 --
52 -- Name Type Description
53 --
54 -- p_approval_comp_id number Primary key of the new
55 -- approval component
56 -- p_object_version_number number Object version number for the
57 -- new approval comp
58 --
59 -- Post Failure:
60 --
61 -- The approval comp will not be created and an application error will be
62 -- raised.
63 --
64 -- Access Status:
65 -- Public.
66 --
67 -- {End Of Comments}
68 --
69 procedure create_approval_comps
70 (p_validate in boolean default false
71 ,p_approval_comp_id in out nocopy number
72 ,p_object_version_number in out nocopy number
73 ,p_approval_mechanism in varchar2
74 ,p_approval_style_id in number
75 ,p_time_recipient_id in number default null
76 ,p_start_date in date
77 ,p_end_date in date
78 ,p_approval_mechanism_id in number default null
79 ,p_approval_order in number default null
80 ,p_wf_item_type in varchar2 default null
81 ,p_wf_name in varchar2 default null
82 ,p_effective_date in date default null
83 ,p_time_category_id in number default null
84 ,p_parent_comp_id in number default null
85 ,p_parent_comp_ovn in number default null
86 ,p_run_recipient_extensions in varchar2 default null
87 );
88 --
89 -- ----------------------------------------------------------------------------
90 -- |------------------------<update_approval_comps> --------------------------|
91 -- ----------------------------------------------------------------------------
92 --
93 -- {Start Of Comments}
94 --
95 -- Description:
96 --
97 -- This API updates an existing Approval Component of an Approval Style
98 --
99 -- Prerequisites:
100 --
101 -- None
102 --
103 -- In Parameters:
104 -- Name Reqd Type Description
105 --
106 -- p_validate No boolean If TRUE then the database
107 -- remains unchanged. If FALSE
108 -- then a new Approval Comp is
109 -- created. Default is FALSE.
110 -- p_approval_comp_id Yes number Primary Key for entity
111 -- p_approval_mechanism Yes varchar2 Approval Mechanism for the
112 -- Style
113 -- p_approval_style_id Yes number Approval Style ID
114 -- p_start_date Yes Date Start Date of the Approval
115 -- Components
116 -- p_end_date Yes Date End Date of the Approval
117 -- Components
118 -- p_time_recipient_id No number ID of the Application to
119 -- which the approval component
120 -- is applicable
121 -- p_approval_mechanism_id No number Approval_mechanism_id
122 -- corresponding to the approval
123 -- mechanism
124 -- p_approval_order No number The Sequence in which the
125 -- Approval Style is applicable
126 -- to the applications
127 -- p_wf_item_type No varchar2 WF_ITEM_TYPE of the workflow
128 -- p_wf_name No varchar2 Workflow Name
129 --
130 -- p_object_version_number No number Object Version Number
131 -- p_effective_date No date Effective date
132 --
133 -- Post Success:
134 --
135 -- when the approval style has been updated successfully the following
136 -- out parameters are set.
137 --
138 -- Name Type Description
139 --
140 -- p_object_version_number Number Object version number for the
141 -- updated approval component
142 --
143 -- Post Failure:
144 --
145 -- The approval component will not be updated and an application error raised
146 --
147 -- Access Status:
148 -- Public.
149 --
150 -- {End Of Comments}
151 --
152 procedure update_approval_comps
153 (p_validate in boolean default false
154 ,p_approval_comp_id in number
155 ,p_object_version_number in out nocopy number
156 ,p_approval_mechanism in varchar2
157 ,p_approval_style_id in number
158 ,p_time_recipient_id in number default null
159 ,p_start_date in date
160 ,p_end_date in date
161 ,p_approval_mechanism_id in number default null
162 ,p_approval_order in number default null
163 ,p_wf_item_type in varchar2 default null
164 ,p_wf_name in varchar2 default null
165 ,p_effective_date in date default null
166 ,p_time_category_id in number default null
167 ,p_parent_comp_id in number default null
168 ,p_parent_comp_ovn in number default null
169 ,p_run_recipient_extensions in varchar2 default null
170 );
171 --
172 -- ----------------------------------------------------------------------------
173 -- |------------------------< delete_approval_comps >------------------------|
174 -- ----------------------------------------------------------------------------
175 --
176 -- {Start Of Comments}
177 --
178 -- Description:
179 --
180 -- This API deletes an existing Approval Component of an Approval Style
181 --
182 -- Prerequisites:
183 --
184 -- None
185 --
186 -- In Parameters:
187 -- Name Reqd Type Description
188 --
189 -- p_validate No boolean If TRUE then the database
190 -- remains unchanged. If FALSE
191 -- then the approval component
192 -- is deleted. Default is FALSE.
193 -- p_approval_comp_id Yes number Primary Key for entity
194 -- p_object_version_number Yes number Object Version Number
195 --
196 -- Post Success:
197 --
198 -- when the approval component has been deleted successfully the process
199 -- completes with success.
200 --
201 -- Post Failure:
202 --
203 -- The approval comp will not be deleted and an application error raised
204 --
205 -- Access Status:
206 -- Public.
207 --
208 -- {End Of Comments}
209 --
210 procedure delete_approval_comps
211 (p_validate in boolean default false
212 ,p_approval_comp_id in number
213 ,p_object_version_number in number
214 );
215 --
216 --
217 END hxc_approval_comps_api;
[Home] [Help]