1 Package pqh_fr_stat_sit_rules_api AUTHID CURRENT_USER as
2 /* $Header: pqstrapi.pkh 120.1 2005/10/02 02:28 aroussel $ */
3 /*#
4 * This package contains APIs to validate, create, update and delete statutory
5 * situation rules.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Statutory Situation Rule for France
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_stat_situation_rule >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API validates and creates a statutory situation rule record.
18 *
19 * Statutory situation is an important employment indicator for civil servants
20 * in French Public Sector. The API records the eligibility rule for a
21 * statutory situation. The record is created in PQH_FR_STAT_SITUATION_RULES
22 * table
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * A statutory situation rule can be created only for an existing statutory
29 * situation.
30 *
31 * <p><b>Post Success</b><br>
32 * A statutory situation rule record is created in the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * A statutory situation rule record is not created in the database and an
36 * error is raised
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_effective_date Specifies the reference date for validating lookup
41 * values, applicable within the active date range. This date does not
42 * determine when the changes take effect.
43 * @param p_statutory_situation_id {@rep:casecolumn
44 * PQH_FR_STAT_SITUATION_RULES.STATUTORY_SITUATION_ID}
45 * @param p_processing_sequence {@rep:casecolumn
46 * PQH_FR_STAT_SITUATION_RULES.PROCESSING_SEQUENCE}
47 * @param p_txn_category_attribute_id Selected transaction category attribute
48 * identifier. Valid transaction category is FR_PQH_STAT_SIT_TXN.
49 * @param p_from_value If the category attribute accepts an exact value, then
50 * the value should be from the predefined set of values. Otherwise its value
51 * must be greater than 0
52 * @param p_to_value This value should be provided only if the category
53 * attribute accepts a range of values, and must be greater than the from_value
54 * @param p_enabled_flag Flag that identifies whether the rule is enabled
55 * currently or not
56 * @param p_required_flag Flag that identifies whether an employee needs to
57 * meet this rule before being eligible to be placed on the corresponding
58 * statutory situation.
59 * @param p_exclude_flag If set to true, then the employee satisfying this rule
60 * will be excluded from being placed on this statutory situation
61 * @param p_stat_situation_rule_id The process returns the unique statutory
62 * situation identifier generated for the new statutory situation record.
63 * @param p_object_version_number If p_validate is false, the process returns
64 * the version number of the created statutory situation rule. If p_validate is
65 * true, it returns null.
66 * @rep:displayname Create Statutory Situation Rule
67 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
68 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
69 * @rep:scope public
70 * @rep:lifecycle active
71 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
72 */
73 --
74 -- {End Of Comments}
75 --
76 procedure create_stat_situation_rule
77 (p_validate in boolean default false
78 ,p_effective_date in date default sysdate
79 ,p_statutory_situation_id in number
80 ,p_processing_sequence in number
81 ,p_txn_category_attribute_id in number
82 ,p_from_value in varchar2
83 ,p_to_value in varchar2 default null
84 ,p_enabled_flag in varchar2 default null
85 ,p_required_flag in varchar2 default null
86 ,p_exclude_flag in varchar2 default null
87 ,p_stat_situation_rule_id out nocopy number
88 ,p_object_version_number out nocopy number
89 );
90 --
91 -- ----------------------------------------------------------------------------
95 -- {Start Of Comments}
92 -- |------------------------< update_stat_situation_rule >--------------------|
93 -- ----------------------------------------------------------------------------
94 --
96 /*#
97 * This API validates the record when an existing statutory situation rule is
98 * changed and updates the record in the database.
99 *
100 * Statutory situation is an important employment indicator for civil servants
101 * in French Public Sector. The API updates the eligibility rule for a
102 * statutory situation.
103 *
104 * <p><b>Licensing</b><br>
105 * This API is licensed for use with Human Resources.
106 *
107 * <p><b>Prerequisites</b><br>
108 * A statutory situation rule must exist with the specified object version
109 * number.
110 *
111 * <p><b>Post Success</b><br>
112 * The existing statutory situation rule record is updated in the database.
113 *
114 * <p><b>Post Failure</b><br>
115 * The existing statutory situation rule is not changed in the database and an
116 * error is raised
117 * @param p_validate If true, then validation alone will be performed and the
118 * database will remain unchanged. If false and all validation checks pass,
119 * then the database will be modified.
120 * @param p_effective_date Specifies the reference date for validating lookup
121 * values, applicable within the active date range. This date does not
122 * determine when the changes take effect.
123 * @param p_stat_situation_rule_id Statutory situation rule identifier assigned
124 * to this record when created as the primary key
125 * @param p_object_version_number Passes in the current version number of the
126 * statutory situation rule to be updated. When the API completes if p_validate
127 * is false, the process returns the new version number of the updated
128 * statutory situation rule If p_validate is true, it returns the same value
129 * which was passed in
130 * @param p_statutory_situation_id {@rep:casecolumn
131 * PQH_FR_STAT_SITUATION_RULES.STATUTORY_SITUATION_ID}
132 * @param p_processing_sequence {@rep:casecolumn
133 * PQH_FR_STAT_SITUATION_RULES.PROCESSING_SEQUENCE}
134 * @param p_txn_category_attribute_id Selected transaction category attribute
135 * identifier. Valid transaction category is FR_PQH_STAT_SIT_TXN.
136 * @param p_from_value If the category attribute accepts an exact value, then
137 * the value should be from the predefined set of values. Otherwise its value
138 * must be greater than 0
139 * @param p_to_value This value should be provided only if the category
140 * attribute accepts a range of values, and must be greater than the from_value
141 * @param p_enabled_flag Flag that identifies whether the rule is enabled
142 * currently or not
143 * @param p_required_flag Flag that identifies whether an employee needs to
144 * meet this rule before being eligible to be placed on the corresponding
145 * statutory situation.
146 * @param p_exclude_flag If set to true, then the employee satisfying this rule
147 * will be excluded from being placed on this statutory situation
148 * @rep:displayname Update Statutory Situation Rule
149 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
150 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
151 * @rep:scope public
152 * @rep:lifecycle active
153 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
154 */
155 --
156 -- {End Of Comments}
157 --
158 procedure update_stat_situation_rule
159 (p_validate in boolean default false
160 ,p_effective_date in date default sysdate
161 ,p_stat_situation_rule_id in number
162 ,p_object_version_number in out nocopy number
163 ,p_statutory_situation_id in number default hr_api.g_number
164 ,p_processing_sequence in number default hr_api.g_number
165 ,p_txn_category_attribute_id in number default hr_api.g_number
166 ,p_from_value in varchar2 default hr_api.g_varchar2
167 ,p_to_value in varchar2 default hr_api.g_varchar2
168 ,p_enabled_flag in varchar2 default hr_api.g_varchar2
169 ,p_required_flag in varchar2 default hr_api.g_varchar2
170 ,p_exclude_flag in varchar2 default hr_api.g_varchar2
171 );
172 --
173 -- ----------------------------------------------------------------------------
174 -- |------------------------< delete_stat_situation_rule >--------------------|
175 -- ----------------------------------------------------------------------------
176 --
177 -- {Start Of Comments}
178 /*#
179 * This API deletes a statutory situation rule record from the database.
180 *
181 * The record is deleted from PQH_FR_STAT_SITUATION_RULES table
182 *
183 * <p><b>Licensing</b><br>
184 * This API is licensed for use with Human Resources.
185 *
186 * <p><b>Prerequisites</b><br>
187 * The statutory situation rule must exist with the specified object version
188 * number.
189 *
190 * <p><b>Post Success</b><br>
191 * The statutory situation rule is deleted from the database.
192 *
193 * <p><b>Post Failure</b><br>
194 * The statutory situation rule is not deleted from the database and an error
195 * is raised
196 * @param p_validate If true, then validation alone will be performed and the
197 * database will remain unchanged. If false and all validation checks pass,
198 * then the database will be modified.
199 * @param p_stat_situation_rule_id Statutory situation rule identifier assigned
200 * to this record when creation as the primary key
201 * @param p_object_version_number Current version number of the statutory
202 * situation rule record to be deleted
203 * @rep:displayname Delete Statutory Situation Rule
204 * @rep:category BUSINESS_ENTITY PQH_FR_STATUTORY_SITUATION
205 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
206 * @rep:scope public
207 * @rep:lifecycle active
208 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
209 */
210 --
211 -- {End Of Comments}
212 --
213 procedure delete_stat_situation_rule
214 (p_validate in boolean default false
215 ,p_stat_situation_rule_id in number
216 ,p_object_version_number in number
217 );
218 --
219
220 end pqh_fr_stat_sit_rules_api;
[Home] [Help]