1 Package hxc_approval_period_comps_api AUTHID CURRENT_USER as
2 /* $Header: hxcapcapi.pkh 120.0 2005/05/29 05:24:07 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_approval_period_comps >----------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
11 -- This API creates the Approval Period 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 Period
23 -- Comp is created.
24 -- Default is FALSE.
25 -- p_approval_period_comp_id Yes number Primary Key for entity
26 -- p_approval_period_set_id Yes number Approval Period Set ID
27 -- p_time_recipient_id Yes number ID of the Application to
28 -- which the approval component
29 -- is applicable
30 -- p_recurring_period_id Yes number Recurring Period ID
31 -- p_object_version_number No number Object Version Number
32 -- p_effective_date No date Effective date
33 --
34 -- Post Success:
35 --
36 -- The OUT PARAMETERS set,after the approval period component has been created
37 -- successfully,are:
38 --
39 -- Name Type Description
40 --
41 -- p_approval_period_comp_id number Primary key of the new
42 -- approval component
43 -- p_object_version_number number Object version number for the
44 -- new approval comp
45 --
46 -- Post Failure:
47 --
48 -- The approval comp will not be created and an application error will be
49 -- raised.
50 --
51 -- Access Status:
52 -- Public.
53 --
54 -- {End Of Comments}
55 --
56 procedure create_approval_period_comps
57 (p_validate in boolean default false
58 ,p_approval_period_comp_id in out nocopy number
59 ,p_object_version_number in out nocopy number
60 ,p_approval_period_set_id in number
61 ,p_time_recipient_id in number
62 ,p_recurring_period_id in number
63 ,p_effective_date in date default null
64 );
65 --
66 -- ----------------------------------------------------------------------------
67 -- |------------------------<update_approval_period_comps> -------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- {Start Of Comments}
71 --
72 -- Description:
73 --
74 -- This API updates an existing Approval Component of an Approval Set
75 --
76 -- Prerequisites:
77 --
78 -- None
79 --
80 -- In Parameters:
81 -- Name Reqd Type Description
82 --
83 -- p_validate No boolean If TRUE then the database
84 -- remains unchanged. If FALSE
85 -- then a new Approval Comp is
86 -- created. Default is FALSE.
87 -- p_approval_period_comp_id Yes number Primary Key for entity
88 -- p_approval_period_set_id Yes number Approval Set ID
89 -- p_time_recipient_id No number ID of the Application to
90 -- which the approval component
91 -- is applicable
92 -- p_recurring_period_id No number Recurring period id
93 -- corresponding to the approval
94 -- comp
95 -- p_object_version_number No number Object Version Number
96 -- p_effective_date No date Effective date
97 --
98 -- Post Success:
99 --
100 -- when the approval comp has been updated successfully the following
101 -- out parameters are set.
102 --
103 -- Name Type Description
104 --
105 -- p_object_version_number Number Object version number for the
106 -- updated approval component
107 --
108 -- Post Failure:
109 --
110 -- The approval component will not be updated and an application error raised
111 --
112 -- Access Status:
113 -- Public.
114 --
115 -- {End Of Comments}
116 --
117 procedure update_approval_period_comps
118 (p_validate in boolean default false
119 ,p_approval_period_comp_id in number
120 ,p_object_version_number in out nocopy number
121 ,p_approval_period_set_id in number
122 ,p_time_recipient_id in number
123 ,p_recurring_period_id in number
124 ,p_effective_date in date default null
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |------------------------< delete_approval_period_comps >------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 --
133 -- Description:
134 --
135 -- This API deletes an existing Approval Component of an Approval Set
136 --
137 -- Prerequisites:
138 --
139 -- None
140 --
141 -- In Parameters:
142 -- Name Reqd Type Description
143 --
144 -- p_validate No boolean If TRUE then the database
145 -- remains unchanged. If FALSE
146 -- then the approval component
147 -- is deleted. Default is FALSE.
148 -- p_approval_period_comp_id Yes number Primary Key for entity
149 -- p_object_version_number Yes number Object Version Number
150 --
151 -- Post Success:
152 --
153 -- when the approval component has been deleted successfully the process
154 -- completes with success.
155 --
156 -- Post Failure:
157 --
158 -- The approval comp will not be deleted and an application error raised
159 --
160 -- Access Status:
161 -- Public.
162 --
163 -- {End Of Comments}
164 --
165 procedure delete_approval_period_comps
166 (p_validate in boolean default false
167 ,p_approval_period_comp_id in number
168 ,p_object_version_number in number
169 );
170 --
171 --
172 END hxc_approval_period_comps_api;
[Home] [Help]