1 Package pqh_TEMPLATE_ATTRIBUTES_api as
2 /* $Header: pqtatapi.pkh 120.1 2005/10/02 02:28:15 aroussel $ */
3 /*#
4 * This package contains template attribute APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Template Attribute
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_template_attribute >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a template attribute.
17 *
18 * The template is associated with a transaction type. Only attributes attached
19 * to the transaction type can be chosen as template attributes.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The template for which the template attribute is created must already exist.
26 * The template must not be frozen. Only the transaction category attributes
27 * attached to the transaction type of the template, which are marked as
28 * selected can be selected as template attributes.
29 *
30 * <p><b>Post Success</b><br>
31 * The template attribute is created successfully in the database.
32 *
33 * <p><b>Post Failure</b><br>
34 * The template attribute is not created and an error is raised.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_required_flag Indicates if the attribute is a required attribute
39 * for which the user must provide a value in the transaction.
40 * @param p_view_flag Indicates if the attribute value can be viewed in the
41 * transaction.
42 * @param p_edit_flag Indicates if the attribute value can be edited in the
43 * transaction.
44 * @param p_template_attribute_id If p_validate is false, then this uniquely
45 * identifies the template attribute created. If p_validate is true, then set
46 * to null.
47 * @param p_attribute_id {@rep:casecolumn PQH_TEMPLATE_ATTRIBUTES.ATTRIBUTE_ID}
48 * @param p_template_id {@rep:casecolumn PQH_TEMPLATE_ATTRIBUTES.TEMPLATE_ID}
49 * @param p_object_version_number If p_validate is false, then set to the
50 * version number of the created template attribute. If p_validate is true,
51 * then the value will be null.
52 * @param p_effective_date Reference date for validating lookup values are
53 * applicable during the start to end active date range. This date does not
54 * determine when the changes take effect.
55 * @rep:displayname Create Template Attribute
56 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
57 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:scope public
59 * @rep:lifecycle active
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_TEMPLATE_ATTRIBUTE
66 (
67 p_validate in boolean default false
68 ,p_required_flag in varchar2 default null
69 ,p_view_flag in varchar2 default null
70 ,p_edit_flag in varchar2 default null
71 ,p_template_attribute_id out nocopy number
72 ,p_attribute_id in number default null
73 ,p_template_id in number default null
74 ,p_object_version_number out nocopy number
75 ,p_effective_date in date
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |------------------------< update_template_attribute >---------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates template attribute details.
85 *
86 * The attribute permissions, for example, whether the attribute is viewable or
87 * editable or required can be updated.
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Human Resources.
91 *
92 * <p><b>Prerequisites</b><br>
93 * The template attribute which is to be updated must already exist. The
94 * template to which the template attribute is attached must be in unfrozen
95 * state.
96 *
97 * <p><b>Post Success</b><br>
98 * The template attribute Is updated successfully in the database.
99 *
100 * <p><b>Post Failure</b><br>
101 * The template attribute is not updated and an error is raised.
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_required_flag Indicates if the attribute is a required attribute
106 * for which the user must provide a value in the transaction.
107 * @param p_view_flag Indicates if the attribute value can be viewed in the
108 * transaction.
109 * @param p_edit_flag Indicates if the attribute value can be edited in the
110 * transaction.
111 * @param p_template_attribute_id Identifies uniquely the template attribute
112 * record to be modified.
113 * @param p_attribute_id {@rep:casecolumn PQH_TEMPLATE_ATTRIBUTES.ATTRIBUTE_ID}
114 * @param p_template_id {@rep:casecolumn PQH_TEMPLATE_ATTRIBUTES.TEMPLATE_ID}
115 * @param p_object_version_number Pass in the current version number of the
116 * template attribute to be updated. When the API completes if p_validate is
117 * false, will be set to the new version number of the updated template
118 * attribute. If p_validate is true will be set to the same value which was
119 * passed in.
120 * @param p_effective_date Reference date for validating lookup values are
121 * applicable during the start to end active date range. This date does not
122 * determine when the changes take effect.
123 * @rep:displayname Update Template Attribute
124 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
125 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure update_TEMPLATE_ATTRIBUTE
134 (
135 p_validate in boolean default false
136 ,p_required_flag in varchar2 default hr_api.g_varchar2
137 ,p_view_flag in varchar2 default hr_api.g_varchar2
138 ,p_edit_flag in varchar2 default hr_api.g_varchar2
139 ,p_template_attribute_id in number
140 ,p_attribute_id in number default hr_api.g_number
141 ,p_template_id in number default hr_api.g_number
142 ,p_object_version_number in out nocopy number
143 ,p_effective_date in date
144 );
145 --
146 -- ----------------------------------------------------------------------------
147 -- |------------------------< delete_template_attribute >---------------------|
148 -- ----------------------------------------------------------------------------
149 --
150 -- {Start Of Comments}
151 /*#
152 * This API deletes the template attribute.
153 *
154 * The template attribute is deleted from pqh_template_attributes table. The
155 * deleted attribute can be selected again and associated with the template and
156 * the attribute permissions can be edited.
157 *
158 * <p><b>Licensing</b><br>
159 * This API is licensed for use with Human Resources.
160 *
161 * <p><b>Prerequisites</b><br>
162 * The template attribute to be deleted must already exist. The template to
163 * which the template attribute is attached must be in unfrozen state.
164 *
165 * <p><b>Post Success</b><br>
166 * The template attribute is deleted successfully from the database.
167 *
168 * <p><b>Post Failure</b><br>
169 * The template attribute is not deleted and an error is raised.
170 * @param p_validate If true, then validation alone will be performed and the
171 * database will remain unchanged. If false and all validation checks pass,
172 * then the database will be modified.
173 * @param p_template_attribute_id Identifies uniquely the template attribute
174 * record to be deleted.
175 * @param p_object_version_number Current version number of the template
176 * attribute to be deleted.
177 * @param p_effective_date Reference date for validating lookup values are
178 * applicable during the start to end active date range. This date does not
179 * determine when the changes take effect.
180 * @rep:displayname Delete Template Attribute
181 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
182 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
183 * @rep:scope public
184 * @rep:lifecycle active
185 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
186 */
187 --
188 -- {End Of Comments}
189 --
190 procedure delete_TEMPLATE_ATTRIBUTE
191 (
192 p_validate in boolean default false
193 ,p_template_attribute_id in number
194 ,p_object_version_number in number
195 ,p_effective_date in date
196 );
197 --
198 --
199 procedure create_update_copied_attribute
200 (
201 p_copied_attributes in pqh_prvcalc.t_attid_priv,
202 p_template_id in number
203 );
204 --
205 --
206 --
207 end pqh_TEMPLATE_ATTRIBUTES_api;
[Home] [Help]