1 Package pqh_REF_TEMPLATES_api as
2 /* $Header: pqrftapi.pkh 120.1 2005/10/02 02:27:21 aroussel $ */
3 /*#
4 * This package contains reference template APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Reference Templates
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_ref_template >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a reference template.
17 *
18 * A reference template allows attributes and the attribute permissions of an
19 * existing template to be either referenced or copied by another template.
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 whose attributes are referenced or copied by the parent
26 * template, must already exist.
27 *
28 * <p><b>Post Success</b><br>
29 * The reference template will be successfully inserted in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The reference template will not be created and an error will be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_ref_template_id If p_validate is false, then this uniquely
37 * identifies the reference template created. If p_validate is true, then set
38 * to null.
39 * @param p_base_template_id The template whose attributes are referenced or
40 * copied by the parent template.
41 * @param p_parent_template_id The referencing template.
42 * @param p_reference_type_cd Indicates if the base template attributes should
43 * be referenced or copied. Valid values are defined by 'PQH_REFERENCE_TYPE'
44 * lookup_type
45 * @param p_object_version_number If p_validate is false, then set to the
46 * version number of the created reference template. If p_validate is true,
47 * then the value will be null.
48 * @param p_effective_date Reference date for validating lookup values are
49 * applicable during the start to end active date range. This date does not
50 * determine when the changes take effect.
51 * @rep:displayname Create Reference Template
52 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
53 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
54 * @rep:scope public
55 * @rep:lifecycle active
56 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
57 */
58 --
59 -- {End Of Comments}
60 --
61 procedure create_REF_TEMPLATE
62 (
63 p_validate in boolean default false
64 ,p_ref_template_id out nocopy number
65 ,p_base_template_id in number
66 ,p_parent_template_id in number
67 ,p_reference_type_cd in varchar2
68 ,p_object_version_number out nocopy number
69 ,p_effective_date in date
70 );
71 --
72 -- ----------------------------------------------------------------------------
73 -- |---------------------------< update_ref_template >------------------------|
74 -- ----------------------------------------------------------------------------
75 --
76 -- {Start Of Comments}
77 /*#
78 * This API updates a reference template record.
79 *
80 * The current template may either copy or reference attributes along with the
81 * attribute permissions from the base template. If the attributes are copied,
82 * then the attribute permissions can be edited for the current template.
83 *
84 * <p><b>Licensing</b><br>
85 * This API is licensed for use with Human Resources.
86 *
87 * <p><b>Prerequisites</b><br>
88 * The template whose attributes are referenced or copied by the parent
89 * template, must already exist.
90 *
91 * <p><b>Post Success</b><br>
92 * The reference template will be successfully updated in the database.
93 *
94 * <p><b>Post Failure</b><br>
95 * The reference template will not be updated and an error will be raised.
96 * @param p_validate If true, then validation alone will be performed and the
97 * database will remain unchanged. If false and all validation checks pass,
98 * then the database will be modified.
99 * @param p_ref_template_id Identifies the reference template record to be
100 * modified.
101 * @param p_base_template_id The template whose attributes are referenced or
102 * copied by the parent template.
103 * @param p_parent_template_id The referencing template.
104 * @param p_reference_type_cd Indicates if the base template attributes should
105 * be referenced or copied. Valid values are defined by 'PQH_REFERENCE_TYPE'
106 * lookup_type
107 * @param p_object_version_number Pass in the current version number of the
108 * reference template to be updated. When the API completes if p_validate is
109 * false, will be set to the new version number of the updated reference
110 * template. If p_validate is true will be set to the same value which was
111 * passed in.
112 * @param p_effective_date Reference date for validating lookup values are
113 * applicable during the start to end active date range. This date does not
114 * determine when the changes take effect.
115 * @rep:displayname Update Reference Template
116 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
117 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
118 * @rep:scope public
119 * @rep:lifecycle active
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure update_REF_TEMPLATE
126 (
127 p_validate in boolean default false
128 ,p_ref_template_id in number
129 ,p_base_template_id in number default hr_api.g_number
130 ,p_parent_template_id in number default hr_api.g_number
131 ,p_reference_type_cd in varchar2 default hr_api.g_varchar2
132 ,p_object_version_number in out nocopy number
133 ,p_effective_date in date
134 );
135 --
136 -- ----------------------------------------------------------------------------
137 -- |---------------------------< delete_ref_template >------------------------|
138 -- ----------------------------------------------------------------------------
139 --
140 -- {Start Of Comments}
141 /*#
142 * The API deletes the reference template record.
143 *
144 * When the reference template is deleted, the attributes copied from the base
145 * template will not be deleted.
146 *
147 * <p><b>Licensing</b><br>
148 * This API is licensed for use with Human Resources.
149 *
150 * <p><b>Prerequisites</b><br>
151 * The parent template must have an unfrozen status, before any templates it
152 * refers can be deleted.
153 *
154 * <p><b>Post Success</b><br>
155 * The reference template will be successfully deleted in the database.
156 *
157 * <p><b>Post Failure</b><br>
158 * The reference template will not be deleted and an error will be raised.
159 * @param p_validate If true, then validation alone will be performed and the
160 * database will remain unchanged. If false and all validation checks pass,
161 * then the database will be modified.
162 * @param p_ref_template_id Identifies the reference template record to be
163 * deleted.
164 * @param p_object_version_number Current version number of the reference
165 * template to be deleted.
166 * @param p_effective_date Reference date for validating lookup values are
167 * applicable during the start to end active date range. This date does not
168 * determine when the changes take effect.
169 * @rep:displayname Delete Reference Template
170 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_TRANS_TEMPLATE
171 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
172 * @rep:scope public
173 * @rep:lifecycle active
174 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
175 */
176 --
177 -- {End Of Comments}
178 --
179 procedure delete_REF_TEMPLATE
180 (
181 p_validate in boolean default false
182 ,p_ref_template_id in number
183 ,p_object_version_number in number
184 ,p_effective_date in date
185 );
186 --
187 --
188 end pqh_REF_TEMPLATES_api;
[Home] [Help]