1 Package PQH_RATE_MATRIX_NODES_API AUTHID CURRENT_USER as
2 /* $Header: pqrmnapi.pkh 120.4 2006/03/14 11:27:29 srajakum noship $ */
3 /*#
4 * This package contains rate matrix node APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rate matrix node
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< <create_rate_matrix_node >--------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API creates a new rate matrix node.
16 *
17 * The API adds the new rate matrix node within the rate matrix hierarchy. The
18 * hierarchy of a node is identified by its level number. Each node except the node
19 * with level number of 1 has a parent node. The API attaches an eligibility profile
20 * to the node. A person is eligible for the rate defined for the node only if they
21 * satisfy the eligibility profile associated with that node.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources and HR Foundation.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The criteria and eligibility profile attached to the rate matrix node must exist.
28 *
29 * <p><b>Post Success</b><br>
30 * The rate matrix node is created.
31 *
32 * <p><b>Post Failure</b><br>
33 * The rate matrix node will not be created and error is raised.
34 *
35 * @param p_validate If true, then validation alone will be performed and
36 * the database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * effective during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_rate_matrix_node_id If p_validate is false, then this uniquely identifies
42 * the rate matrix node created. If p_validate is true, then set to null.
43 * @param p_short_code Uniquely identifies a rate matrix node within the rate matrix.
44 * @param p_pl_id Rate matrix plan to which the rate matrix node belongs to.
45 * @param p_level_number The level of the rate matrix node in the rate matrix hierarchy.
46 * @param p_criteria_short_code Identifies the criteria attached to this node.
47 * @param p_node_name Node name.
48 * @param p_parent_node_id Parent node to the current node in the rate matrix hierarchy.
49 * @param p_eligy_prfl_id Eligibility profile attached to the rate matrix node.
50 * @param p_business_group_id Business group of the rate matrix node.
51 * @param p_legislation_code Legislation of the rate matrix node.
52 * @param p_object_version_number If p_validate is false, then set to
53 * the version number of the created rate matrix node. If p_validate is true, then
54 * the value will be null.
55 * @rep:displayname Create rate matrix node
56 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
57 * @rep:lifecycle active
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_rate_matrix_node
66 (p_validate in boolean default false
67 ,p_effective_date in date
68 ,p_rate_matrix_node_id out nocopy number
69 ,p_short_code in varchar2
70 ,p_pl_id in number
71 ,p_level_number in number
72 ,p_criteria_short_code in varchar2 default null
73 ,p_node_name in varchar2
74 ,p_parent_node_id in number default null
75 ,p_eligy_prfl_id in number default null
76 ,p_business_group_id in number default null
77 ,p_legislation_code in varchar2 default null
78 ,p_object_version_number out nocopy number
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |--------------------------< <update_rate_matrix_node >--------------------------|
83 -- ----------------------------------------------------------------------------
84 -- {Start Of Comments}
85 /*#
86 * This API updates a rate matrix node details.
87 *
88 * The API validates that each rate matrix node has a unique name and short_code.
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Human Resources and HR Foundation.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The criteria and eligibility profile attached to the rate matrix node must exist.
95 *
96 * <p><b>Post Success</b><br>
97 * The rate matrix node details are sucessfully updated.
98 *
99 * <p><b>Post Failure</b><br>
100 * The rate matrix node is updated and error is raised.
101 *
102 * @param p_validate If true, then validation alone will be performed and
103 * the database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_effective_date Reference date for validating lookup values are
106 * effective during the start to end active date range. This date does not
107 * determine when the changes take effect.
108 * @param p_rate_matrix_node_id If p_validate is false, then this uniquely identifies
109 * the rate matrix node created. If p_validate is true, then set to null.
110 * @param p_short_code Uniquely identifies a rate matrix node within the rate matrix.
111 * @param p_pl_id Rate matrix plan to which the rate matrix node belongs to.
112 * @param p_level_number The level of the rate matrix node in the rate matrix hierarchy.
113 * @param p_criteria_short_code Identifies the criteria attached to this node.
114 * @param p_node_name Node name.
115 * @param p_parent_node_id Parent node to the current node in the rate matrix hierarchy.
116 * @param p_eligy_prfl_id Eligibility profile attached to the rate matrix node.
117 * @param p_business_group_id Business group of the rate matrix node.
118 * @param p_legislation_code Legislation of the rate matrix node.
119 * @param p_object_version_number Pass in the current version number of the rate matrix
120 * node to be updated. When the API completes if p_validate is false, will be set to the
121 * new version number of the updated rate matrix node. If p_validate is true will be set to
122 * the same value which was passed in.
123 * @rep:displayname Update rate matrix node
124 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
125 * @rep:lifecycle active
126 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
127 * @rep:scope public
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure update_rate_matrix_node
134 (p_validate in boolean default false
135 ,p_effective_date in date
136 ,p_rate_matrix_node_id in number
137 ,p_short_code in varchar2
138 ,p_pl_id in number
139 ,p_level_number in number
140 ,p_criteria_short_code in varchar2 default null
141 ,p_node_name in varchar2
142 ,p_parent_node_id in number default null
143 ,p_eligy_prfl_id in number default null
144 ,p_business_group_id in number default null
145 ,p_legislation_code in varchar2 default null
146 ,p_object_version_number in out nocopy number
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |--------------------------< <delete_rate_matrix_node >--------------------------|
151 -- ----------------------------------------------------------------------------
152 -- {Start Of Comments}
153 --
154 /*#
155 * This API deletes a rate matrix node.
156 *
157 * All child rate matrix nodes must be deleted before the current rate matrix node is
158 * to maintain the rate matrix hierarchy.
159 *
160 * <p><b>Licensing</b><br>
161 * This API is licensed for use with Human Resources and HR Foundation.
162 *
163 * <p><b>Prerequisites</b><br>
164 * The node values and node rates defined for a rate matrix node must be deleted
165 * before a rate matrix node can be deleted.
166 *
167 * <p><b>Post Success</b><br>
168 * The rate matrix node is successfully deleted.
169 *
170 * <p><b>Post Failure</b><br>
171 * The rate matrix node is not deleted and error is raised.
172 *
173 * @param p_validate If true, then validation alone will be performed and
174 * the database will remain unchanged. If false and all validation checks pass,
175 * then the database will be modified.
176 * @param p_effective_date Reference date for validating lookup values
177 * are applicable during the start to end active date range. This date does not
178 * determine when the changes take effect.
179 * @param p_rate_matrix_node_id Identifies the rate matrix node to be deleted.
180 * @param p_object_version_number Current version number of the rate matrix
181 * node to be deleted.
182 * @rep:displayname Delete rate matrix node
183 * @rep:category BUSINESS_ENTITY PQH_RBC_RATE_MATRIX
184 * @rep:lifecycle active
185 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
186 * @rep:scope public
187 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
188 */
189 --
190 -- {End Of Comments}
191 --
192 procedure delete_rate_matrix_node
193 (p_validate in boolean default false
194 ,p_effective_date in date
195 ,p_RATE_MATRIX_NODE_ID in number
196 ,p_object_version_number in number
197 );
198 --
199 end PQH_RATE_MATRIX_NODES_API;
[Home] [Help]