1 Package pqh_tEMPLATES_api AUTHID CURRENT_USER as
2 /* $Header: pqtemapi.pkh 120.1 2005/10/02 02:28:32 aroussel $ */
3 /*#
4 * This package contains transaction template APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Transaction Template
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_generic_template >----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a transaction template.
17 *
18 * The transaction template affects which fields in a transaction workflow
19 * recipients can view and edit appropriate to the task and their workflow
20 * role.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * The transaction category must exist for which the transaction template is
27 * defined.
28 *
29 * <p><b>Post Success</b><br>
30 * The transaction template will be successfully inserted in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * The transaction template will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_template_name {@rep:casecolumn PQH_TEMPLATES.TEMPLATE_NAME}
38 * @param p_short_name {@rep:casecolumn PQH_TEMPLATES.SHORT_NAME}
39 * @param p_template_id If p_validate is false, then this uniquely identifies
40 * the template created. If p_validate is true, then set to null.
41 * @param p_attribute_only_flag Identifies if the current template can
42 * reference other templates. Valid values are defined by 'YES_NO' lookup_type.
43 * @param p_enable_flag Identifies if the templates is Enabled/Disabled. Valid
44 * values are defined by 'YES_NO' lookup_type.
45 * @param p_create_flag Identifies if the template is create or update task
46 * template. Valid values are defined by 'YES_NO' lookup_type.
47 * @param p_transaction_category_id {@rep:casecolumn
48 * PQH_TEMPLATES.TRANSACTION_CATEGORY_ID}
49 * @param p_under_review_flag Indicates if a transaction is to be placed under
50 * review after the template is applied to it. It is applicable for update task
51 * templates only. Valid values are defined by 'YES_NO' lookup_type.
52 * @param p_object_version_number If p_validate is false, then set to the
53 * version number of the created template. If p_validate is true, then the
54 * value will be null.
55 * @param p_freeze_status_cd Identifies if the template setup is frozen or not.
56 * Valid values are defined by 'PQH_TEMPLATE_FREEZE_STATUS' lookup_type.
57 * @param p_template_type_cd Identifies if the template is a task or role
58 * template. Valid values are defined by 'PQH_TEMPLATE_TYPE' lookup type.
59 * @param p_legislation_code {@rep:casecolumn PQH_TEMPLATES.LEGISLATION_CODE}
60 * @param p_effective_date Reference date for validating lookup values are
61 * applicable during the start to end active date range. This date does not
62 * determine when the changes take effect.
63 * @param p_language_code Specifies to which language the translation values
64 * apply. You can set to the base or any installed language. The default value
65 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
66 * value.
67 * @rep:displayname Create Transaction Template
68 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
69 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
70 * @rep:scope public
71 * @rep:lifecycle active
72 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
73 */
74 --
75 -- {End Of Comments}
76 --
77 procedure create_GENERIC_TEMPLATE
78 (
79 p_validate in boolean default false
80 ,p_template_name in varchar2
81 ,p_short_name in varchar2
82 ,p_template_id out nocopy number
83 ,p_attribute_only_flag in varchar2 default null
84 ,p_enable_flag in varchar2 default 'Y'
85 ,p_create_flag in varchar2 default null
86 ,p_transaction_category_id in number
87 ,p_under_review_flag in varchar2 default null
88 ,p_object_version_number out nocopy number
89 ,p_freeze_status_cd in varchar2 default null
90 ,p_template_type_cd in varchar2
91 ,p_legislation_code in varchar2 default null
92 ,p_effective_date in date
93 ,p_language_code in varchar2 default hr_api.userenv_lang
94 );
95 --
96 -- ----------------------------------------------------------------------------
97 -- |-------------------------< update_generic_template >----------------------|
98 -- ----------------------------------------------------------------------------
99 --
100 -- {Start Of Comments}
101 /*#
102 * This API updates the transaction template that affects which fields workflow
103 * recipients can view and edit appropriate to the task and their workflow
104 * role.
105 *
106 * A transaction template can be updated only if the setup is not frozen.
107 * Seeded task and role templates do not allow edit.
108 *
109 * <p><b>Licensing</b><br>
110 * This API is licensed for use with Human Resources.
111 *
112 * <p><b>Prerequisites</b><br>
113 * A Transaction template must be unfrozen before it can be updated.
114 *
115 * <p><b>Post Success</b><br>
116 * The transaction template details will be updated successfully.
117 *
118 * <p><b>Post Failure</b><br>
119 * The transaction template will not be updated and an error will be raised.
120 * @param p_validate If true, then validation alone will be performed and the
121 * database will remain unchanged. If false and all validation checks pass,
122 * then the database will be modified.
123 * @param p_template_name {@rep:casecolumn PQH_TEMPLATES.TEMPLATE_NAME}
124 * @param p_short_name {@rep:casecolumn PQH_TEMPLATES.SHORT_NAME}
125 * @param p_template_id Identifies the template record to be modified.
126 * @param p_attribute_only_flag Identifies if the current template can
127 * reference other templates. Valid values are defined by 'YES_NO' lookup_type.
128 * @param p_enable_flag Identifies if the templates is Enabled/Disabled. Valid
129 * values are defined by 'YES_NO' lookup_type.
130 * @param p_create_flag Identifies if the template is create or update task
131 * template. Valid values are defined by 'YES_NO' lookup_type.
132 * @param p_transaction_category_id {@rep:casecolumn
133 * PQH_TEMPLATES.TRANSACTION_CATEGORY_ID}
134 * @param p_under_review_flag Identifies if a transaction is to be placed under
135 * review after the template is applied to it. It is applicable for update task
136 * templates only. Valid values are defined by 'YES_NO' lookup_type.
137 * @param p_object_version_number Pass in the current version number of the
138 * template to be updated. When the API completes if p_validate is false, will
139 * be set to the new version number of the updated template. If p_validate is
140 * true will be set to the same value which was passed in.
141 * @param p_freeze_status_cd Indicates if the template setup is frozen or not.
142 * Valid values are defined by 'PQH_TEMPLATE_FREEZE_STATUS' lookup_type.
143 * @param p_template_type_cd Identifies if the template is a task or role
144 * template. Valid values are defined by 'PQH_TEMPLATE_TYPE' lookup type.
145 * @param p_legislation_code {@rep:casecolumn PQH_TEMPLATES.LEGISLATION_CODE}
146 * @param p_effective_date Reference date for validating lookup values are
147 * applicable during the start to end active date range. This date does not
148 * determine when the changes take effect.
149 * @param p_language_code Specifies to which language the translation values
150 * apply. You can set to the base or any installed language. The default value
151 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
152 * value.
153 * @rep:displayname Update Transaction Template
154 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
155 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
156 * @rep:scope public
157 * @rep:lifecycle active
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 procedure update_GENERIC_TEMPLATE
164 (
165 p_validate in boolean default false
166 ,p_template_name in varchar2 default hr_api.g_varchar2
167 ,p_short_name in varchar2 default hr_api.g_varchar2
168 ,p_template_id in number
169 ,p_attribute_only_flag in varchar2 default hr_api.g_varchar2
170 ,p_enable_flag in varchar2 default hr_api.g_varchar2
171 ,p_create_flag in varchar2 default hr_api.g_varchar2
172 ,p_transaction_category_id in number default hr_api.g_number
173 ,p_under_review_flag in varchar2 default hr_api.g_varchar2
174 ,p_object_version_number in out nocopy number
175 ,p_freeze_status_cd in varchar2 default hr_api.g_varchar2
176 ,p_template_type_cd in varchar2
177 ,p_legislation_code in varchar2 default hr_api.g_varchar2
178 ,p_effective_date in date
179 ,p_language_code in varchar2 default hr_api.userenv_lang
180 );
181 --
182 -- ----------------------------------------------------------------------------
183 -- |-------------------------< delete_generic_template >----------------------|
184 -- ----------------------------------------------------------------------------
185 --
186 -- {Start Of Comments}
187 /*#
188 * This API deletes the transaction template that affects which fields workflow
189 * recipients can view and edit appropriate to the task and their workflow
190 * role.
191 *
192 * Seeded task and role templates cannot be deleted.
193 *
194 * <p><b>Licensing</b><br>
195 * This API is licensed for use with Human Resources.
196 *
197 * <p><b>Prerequisites</b><br>
198 * The template can be deleted only if it has no template attributes. The
199 * template must not be referenced by other templates nor should it reference
200 * other templates. It must not be used to restrict the edit/view privilege of
201 * fields in a transaction.
202 *
203 * <p><b>Post Success</b><br>
204 * The template will be deleted from the database successfully.
205 *
206 * <p><b>Post Failure</b><br>
207 * The template will not be deleted and an error will be raised.
208 * @param p_validate If true, then validation alone will be performed and the
209 * database will remain unchanged. If false and all validation checks pass,
210 * then the database will be modified.
211 * @param p_template_id Identifies the template record to be deleted.
212 * @param p_object_version_number Current version number of the template to be
213 * deleted.
214 * @param p_effective_date Reference date for validating lookup values are
215 * applicable during the start to end active date range. This date does not
216 * determine when the changes take effect.
217 * @rep:displayname Delete Transaction Template
218 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
219 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
220 * @rep:scope public
221 * @rep:lifecycle active
222 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
223 */
224 --
225 -- {End Of Comments}
226 --
227 procedure delete_GENERIC_TEMPLATE
228 (
229 p_validate in boolean default false
230 ,p_template_id in number
231 ,p_object_version_number in number
232 ,p_effective_date in date
233 );
234 --
235 end pqh_TEMPLATES_api;
[Home] [Help]