1 Package PQH_ROLE_TEMPLATES_api as
2 /* $Header: pqrtmapi.pkh 120.1 2005/10/02 02:27:52 aroussel $ */
3 /*#
4 * This package contains role template APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Role Template
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_role_template >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API allows one or more role templates to be associated to a given role.
17 *
18 * The role templates associated to a role establish the maximum set of
19 * permissions for that role, for a particular transaction type. Once the role
20 * templates are setup, the application automatically applies the appropriate
21 * role template when users initiate a transaction or open a routed
22 * transaction.
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 * There are no prereqs for this API.
29 *
30 * <p><b>Post Success</b><br>
31 * The role template associating the selected template and role is created
32 * successfully in the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The role template is not created and an error is raised.
36 * @param p_validate If true, then validation alone will be performed and the
37 * database will remain unchanged. If false and all validation checks pass,
38 * then the database will be modified.
39 * @param p_role_template_id If p_validate is false, then this uniquely
40 * identifies the role template created. If p_validate is true, then set to
41 * null.
42 * @param p_role_id Identifies the role for which you create the role template
43 * record.
44 * @param p_transaction_category_id Identifies the transaction type for which
45 * the role template is created.
46 * @param p_template_id Identifies the transaction template associated with the
47 * role.
48 * @param p_enable_flag Indicates if the role template is enabled/disabled.
49 * Valid values are defined by 'YES_NO' lookup_type
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created role template. If p_validate is true, then the
52 * value will be null
53 * @param p_effective_date Reference date for validating lookup values are
54 * applicable during the start to end active date range. This date does not
55 * determine when the changes take effect.
56 * @rep:displayname Create Role Template
57 * @rep:category BUSINESS_ENTITY HR_ROLE
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_role_template
67 (
68 p_validate in boolean default false
69 ,p_role_template_id out nocopy number
70 ,p_role_id in number default null
71 ,p_transaction_category_id in number default null
72 ,p_template_id in number default null
73 ,p_enable_flag in varchar2 default 'Y'
74 ,p_object_version_number out nocopy number
75 ,p_effective_date in date
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |---------------------------< update_role_template >-----------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates the role template associated to a given role.
85 *
86 * The role template cannot be enabled if the role to which it is associated is
87 * disabled. Different role template can be associated to the role, thus
88 * changing role permissions.
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Human Resources.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The role template which is to be updated must already exist. The Transaction
95 * template that is attached to the role must be enabled and frozen.
96 *
97 * <p><b>Post Success</b><br>
98 * The role template is updated successfully in the database.
99 *
100 * <p><b>Post Failure</b><br>
101 * The role template 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_role_template_id If p_validate is false, then this uniquely
106 * identifies the updated role template. If p_validate is true, then set to
107 * null.
108 * @param p_role_id Identifies the role with which a transaction template is
109 * associated.
110 * @param p_template_id Identifies the transaction template associated with the
111 * role.
112 * @param p_enable_flag Indicates if the role template is enabled/disabled.
113 * Valid values are defined by 'YES_NO' lookup_type
114 * @param p_object_version_number Pass in the current version number of the
115 * role template to be updated. When the API completes if p_validate is false,
116 * will be set to the new version number of the updated role template. If
117 * p_validate is true will be set to the same value which was passed in.
118 * @param p_effective_date Reference date for validating lookup values are
119 * applicable during the start to end active date range. This date does not
120 * determine when the changes take effect.
121 * @rep:displayname Update Role Template
122 * @rep:category BUSINESS_ENTITY HR_ROLE
123 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
124 * @rep:scope public
125 * @rep:lifecycle active
126 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
127 */
128 --
129 -- {End Of Comments}
130 --
131 procedure update_role_template
132 (
133 p_validate in boolean default false
134 ,p_role_template_id in number
135 ,p_role_id in number default hr_api.g_number
136 -- ,p_transaction_category_id in number default hr_api.g_number
137 ,p_template_id in number default hr_api.g_number
138 ,p_enable_flag in varchar2 default hr_api.g_varchar2
139 ,p_object_version_number in out nocopy number
140 ,p_effective_date in date
141 );
142 --
143 -- ----------------------------------------------------------------------------
144 -- |---------------------------< delete_role_template >-----------------------|
145 -- ----------------------------------------------------------------------------
146 --
147 -- {Start Of Comments}
148 /*#
149 * This API deletes a role template from a given role.
150 *
151 * A role must have at least one role template attached to it for the user to
152 * be able to work on a position transaction.
153 *
154 * <p><b>Licensing</b><br>
155 * This API is licensed for use with Human Resources.
156 *
157 * <p><b>Prerequisites</b><br>
158 * The role template to be deleted must already exist.
159 *
160 * <p><b>Post Success</b><br>
161 * The role template is deleted successfully from the database.
162 *
163 * <p><b>Post Failure</b><br>
164 * The role template is not deleted and an error is raised.
165 * @param p_validate If true, then validation alone will be performed and the
166 * database will remain unchanged. If false and all validation checks pass,
167 * then the database will be modified.
168 * @param p_role_template_id If p_validate is false, then this uniquely
169 * identifies the role template created. If p_validate is true, then set to
170 * null.
171 * @param p_object_version_number Current version of the role template to be
172 * deleted.
173 * @param p_effective_date Reference date for validating lookup values are
174 * applicable during the start to end active date range. This date does not
175 * determine when the changes take effect.
176 * @rep:displayname Delete Role Template
177 * @rep:category BUSINESS_ENTITY HR_ROLE
178 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
179 * @rep:scope public
180 * @rep:lifecycle active
181 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
182 */
183 --
184 -- {End Of Comments}
185 --
186 procedure delete_role_template
187 (
188 p_validate in boolean default false
189 ,p_role_template_id in number
190 ,p_object_version_number in out nocopy number
191 ,p_effective_date in date
192 );
193 --
194 --
195 end PQH_ROLE_TEMPLATES_api;
[Home] [Help]