1 Package PER_JOB_GROUP_API as
2 /* $Header: pejgrapi.pkh 120.1 2005/10/02 02:18:06 aroussel $ */
3 /*#
4 * This package contains APIs that create and maintain job group information.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Job Group
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_job_group >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a job group.
17 *
18 * Every job must be a member of a job group. There is also a special job group
19 * called the 'Default HR Job Group'. In the HR Application, users can only see
20 * jobs within this default job group. (Example: the 'Job' list of values on
21 * the assignment form.) Creating a business group in HR creates the Default HR
22 * Job Group, not this API. You can use other job groups to partition jobs into
23 * different families for use in Oracle Projects, or when creating
24 * supplementary roles. A job group can be global in scope, or business-group
25 * specific.
26 *
27 * <p><b>Licensing</b><br>
28 * This API is licensed for use with Human Resources and HR Foundation.
29 *
30 * <p><b>Prerequisites</b><br>
31 * None.
32 *
33 * <p><b>Post Success</b><br>
34 * A job group will be created.
35 *
36 * <p><b>Post Failure</b><br>
37 * A job group will not be created and an error will be raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_effective_date Reference date for validating lookup values are
42 * applicable during the start to end active date range. This date does not
43 * determine when the changes take effect.
44 * @param p_business_group_id Uniquely identifies the business group in which
45 * the job group is created. Leave the value null to specify that the job group
46 * is global.
47 * @param p_legislation_code The legislation code linked to the Job Group. If
48 * passed in, it must be the same as the legislation for the business group
49 * (null if the business group is null).
50 * @param p_internal_name The internal system name of the Job Group. System
51 * processing uses this as a developer key. Oracle recommends you set this to
52 * the same value as the 'displayed name'. The internal name is set to
53 * 'HR_<business group id>' for the HR Default Job Group. You cannot
54 * update it.
55 * @param p_displayed_name The displayed name of the Job Group. This will be
56 * the name, the application displays in user interfaces.
57 * @param p_id_flex_num Uniquely identifies the Job Key Flexfield structure
58 * associated with the Job Group.
59 * @param p_master_flag Indicates whether the Job Group is the Master Job Group
60 * in the business group. Only the Oracle Projects application uses this
61 * designation, and it has no relevance in Oracle HRMS.
62 * @param p_job_group_id If p_validate is false, this uniquely identifies the
63 * Job Group created. If p_validate is true, this parameter will be null.
64 * @param p_object_version_number If p_validate is false, then set to the
65 * version number of the created job group. If p_validate is true, then the
66 * value will be null.
67 * @rep:displayname Create Job Group
68 * @rep:category BUSINESS_ENTITY PER_JOB_GROUP
69 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
70 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
71 * @rep:scope public
72 * @rep:lifecycle active
73 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
74 */
75 --
76 -- {End Of Comments}
77 --
78 procedure CREATE_JOB_GROUP
79 (p_validate in boolean default false
80 ,p_effective_date in date
81 ,p_business_group_id in number default null
82 ,p_legislation_code in varchar2 default null
83 ,p_internal_name in varchar2
84 ,p_displayed_name in varchar2
85 ,p_id_flex_num in number
86 ,p_master_flag in varchar2 default 'N'
87 ,p_job_group_id out nocopy number
88 ,p_object_version_number out nocopy number
89 );
90 --
91 -- ----------------------------------------------------------------------------
92 -- |-----------------------------< update_job_group >-------------------------|
93 -- ----------------------------------------------------------------------------
94 --
95 -- {Start Of Comments}
96 /*#
97 * This API updates a job group.
98 *
99 * Every job must be a member of a job group. There is also a special job group
100 * called the 'Default HR Job Group'. In the HR Application, users can only see
101 * jobs within this default job group. (Example: the 'Job' list of values on
102 * the assignment form.) Creating a business group in HR creates the Default HR
103 * Job Group, not this API. You can use other job groups to partition jobs into
104 * different families for use in Oracle Projects, or when creating
105 * supplementary roles. A job group can be global in scope, or business-group
106 * specific.
107 *
108 * <p><b>Licensing</b><br>
109 * This API is licensed for use with Human Resources and HR Foundation.
110 *
111 * <p><b>Prerequisites</b><br>
112 * The Job Group record must exist.
113 *
114 * <p><b>Post Success</b><br>
115 * The Job Group will be updated.
116 *
117 * <p><b>Post Failure</b><br>
118 * The Job Group will not be updated and an error will be raised.
119 * @param p_validate If true, then validation alone will be performed and the
120 * database will remain unchanged. If false and all validation checks pass,
121 * then the database will be modified.
122 * @param p_effective_date Reference date for validating lookup values are
123 * applicable during the start to end active date range. This date does not
124 * determine when the changes take effect.
125 * @param p_job_group_id Uniquely identifies the job group to be updated.
126 * @param p_business_group_id Uniquely identifies the business group in which
127 * the job group is created. Leave the value null to specify that the job group
128 * is global. You cannot update it, so Oracle recommends that you don't pass
129 * this value to the API.
130 * @param p_legislation_code The legislation code linked to the Job Group. If
131 * passed in, it must be the same as the legislation for the business group
132 * (null if the business group is null).
133 * @param p_internal_name The internal system name of the Job Group. System
134 * processing uses this as a developer key. Oracle recommends you set this to
135 * the same value as the 'displayed name'. The internal name is set to
136 * 'HR_<business group id>' for the HR Default Job Group. You cannot
137 * update it, so Oracle recommends you don't pass to this API.
138 * @param p_displayed_name The displayed name of the Job Group. This will be
139 * the name the application displays in user interfaces. Unlike the internal
140 * name, you can update it.
141 * @param p_id_flex_num Uniquely identifies the Job Key Flexfield structure
142 * associated with the Job Group. You cannot update it, so Oracle recommends
143 * that you don't pass this value to the API.
144 * @param p_master_flag Indicates whether the Job Group is the Master Job Group
145 * in the business group. Only the Oracle Projects application uses this
146 * designation, and it has no relevance in Oracle HRMS.
147 * @param p_object_version_number Passes in the current version number of the
148 * job group to be updated. When the API completes if p_validate is false, will
149 * be set to the new version number of the updated job group. If p_validate is
150 * true will be set to the same value which was passed in.
151 * @rep:displayname Update Job Group
152 * @rep:category BUSINESS_ENTITY PER_JOB_GROUP
153 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
154 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
155 * @rep:scope public
156 * @rep:lifecycle active
157 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
158 */
159 --
160 -- {End Of Comments}
161 --
162 procedure UPDATE_JOB_GROUP
163 (p_validate in boolean default false
164 ,p_effective_date in date
165 ,p_job_group_id in number
166 ,p_business_group_id in number default hr_api.g_number
167 ,p_legislation_code in varchar2 default hr_api.g_varchar2
168 ,p_internal_name in varchar2
169 ,p_displayed_name in varchar2
170 ,p_id_flex_num in number
171 ,p_master_flag in varchar2 default hr_api.g_varchar2
172 ,p_object_version_number in out nocopy number
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |-----------------------------< delete_job_group >-------------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 -- {Start Of Comments}
180 /*#
181 * This API deletes a job group.
182 *
183 * Every job must be a member of a job group. There is also a special job group
184 * called the 'Default HR Job Group'. In the HR Application, users can only see
185 * jobs within this default job group. (Example: the 'Job' list of values on
186 * the assignment form.) Creating a business group in HR creates the Default HR
187 * Job Group, not this API. You can use other job groups to partition jobs into
188 * different families for use in Oracle Projects, or when creating
189 * supplementary roles. A job group can be global in scope, or business-group
190 * specific.
191 *
192 * <p><b>Licensing</b><br>
193 * This API is licensed for use with Human Resources and HR Foundation.
194 *
195 * <p><b>Prerequisites</b><br>
196 * The job group must be exist. A job group cannot be deleted if there are jobs
197 * within it.
198 *
199 * <p><b>Post Success</b><br>
200 * The job group is deleted.
201 *
202 * <p><b>Post Failure</b><br>
203 * The job group is not deleted and an error will be raised.
204 * @param p_validate If true, then validation alone will be performed and the
205 * database will remain unchanged. If false and all validation checks pass,
206 * then the database will be modified.
207 * @param p_job_group_id Uniquely identifes the job group to be deleted.
208 * @param p_object_version_number Current version number of the job group to be
209 * deleted.
210 * @rep:displayname Delete Job Group
211 * @rep:category BUSINESS_ENTITY PER_JOB_GROUP
212 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
213 * @rep:scope public
214 * @rep:lifecycle active
215 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
216 */
217 --
218 -- {End Of Comments}
219 --
220 procedure DELETE_JOB_GROUP
221 (p_validate in boolean default false
222 ,p_job_group_id in number
223 ,p_object_version_number in number
224 );
225 --
226 end PER_JOB_GROUP_API;
[Home] [Help]