1 Package IRC_ASG_STATUS_API as
2 /* $Header: iriasapi.pkh 120.2 2008/02/21 14:06:18 viviswan noship $ */
3 /*#
4 * This package contains Assignment Status History APIs.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Assignment Status History
8 */
9
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------< dt_delete_irc_asg_status >-------------------------|
13 -- ----------------------------------------------------------------------------
14 -- {Start Of Comments}
15 --
16 -- Description:
17 -- This api updates a primary system status for the assignment of an applicant
18 -- depending on the datetrack mode
19 --
20 -- Prerequisites:
21 -- A valid assignment id is required for creating a primary system status.
22 --
23 -- In Parameters:
24 -- Name Reqd Type Description
25 --
26 -- P_VALIDATE N boolean If true is passed then
27 -- the database value will
28 -- rollback
29 -- P_ASSIGNMENT_ID Y number Assignment Id
30 -- P_ASSIGNMENT_STATUS_TYPE_ID Y number Assignment Status Type Id
31 -- P_STATUS_CHANGE_DATE Y date Status change date
32 -- P_STATUS_CHANGE_REASON N varchar2 Status Change Reason
33 -- P_DATETRACK_MODE Y varchar2 Datetrack mode
34 --
35 -- Post Success:
36 -- The API creates a primary system status and sets the following out
37 -- parameters
38 --
39 -- Name Type Description
40 --
41 -- P_OBJECT_VERSION_NUMBER number After a system status is created
42 -- object version number is set to 1
43 -- P_ASSIGNMENT_STATUS_ID number Automatically assignment status
44 -- id is generated by a sequence
45 --
46 -- Post Failure:
47 --
48 -- The api does not create/update a assignment status and an error is raised
49 --
50 -- Access Status:
51 -- Internal Use Only
52 --
53 -- {End Of Comments}
54 --
55 procedure dt_delete_irc_asg_status
56 ( p_validate in boolean default false
57 , p_assignment_status_id in number
58 , p_object_version_number in number
59 , p_effective_date in date
60 , p_datetrack_mode in varchar2);
61
62 --
63 -- ----------------------------------------------------------------------------
64 -- |---------------------< dt_update_irc_asg_status >-------------------------|
65 -- ----------------------------------------------------------------------------
66 -- {Start Of Comments}
67 --
68 -- Description:
69 -- This api updates a primary system status for the assignment of an applicant
70 -- depending on the datetrack mode
71 --
72 -- Prerequisites:
73 -- A valid assignment id is required for creating a primary system status.
74 --
75 -- In Parameters:
76 -- Name Reqd Type Description
77 --
78 -- P_VALIDATE N boolean If true is passed then
79 -- the database value will
80 -- rollback
81 -- P_ASSIGNMENT_ID Y number Assignment Id
82 -- P_ASSIGNMENT_STATUS_TYPE_ID Y number Assignment Status Type Id
83 -- P_STATUS_CHANGE_DATE Y date Status change date
84 -- P_STATUS_CHANGE_REASON N varchar2 Status Change Reason
85 -- P_DATETRACK_MODE Y varchar2 Datetrack mode
86 --
87 -- Post Success:
88 -- The API creates a primary system status and sets the following out
89 -- parameters
90 --
91 -- Name Type Description
92 --
93 -- P_OBJECT_VERSION_NUMBER number After a system status is created
94 -- object version number is set to 1
95 -- P_ASSIGNMENT_STATUS_ID number Automatically assignment status
96 -- id is generated by a sequence
97 --
98 -- Post Failure:
99 --
100 -- The api does not create/update a assignment status and an error is raised
101 --
102 -- Access Status:
103 -- Internal Use Only
104 --
105 -- {End Of Comments}
106 --
107 procedure dt_update_irc_asg_status
108 (
109 p_validate in boolean default false
110 , p_datetrack_mode in varchar2
111 , p_assignment_id in number
112 , p_assignment_status_type_id in number
113 , p_status_change_date in date
114 , p_status_change_reason in varchar2 default hr_api.g_varchar2
115 , p_assignment_status_id out nocopy number
116 , p_object_version_number out nocopy number
117 );
118 --
119 -- ----------------------------------------------------------------------------
120 -- |--------------------------< create_irc_asg_status >-----------------------|
121 -- ----------------------------------------------------------------------------
122 --
123 -- {Start Of Comments}
124 /*#
125 * This API creates an Assignment Status History entry.
126 *
127 * The assignment status history is an audit of all of the changes to an
128 * applicant's assignment status.
129 *
130 * <p><b>Licensing</b><br>
131 * This API is licensed for use with iRecruitment.
132 *
133 * <p><b>Prerequisites</b><br>
134 * A valid assignment is required for creating an assignment status history
135 * entry
136 *
137 * <p><b>Post Success</b><br>
138 * An assignment status history entry will be created in the database
139 *
140 * <p><b>Post Failure</b><br>
141 * The assignment status history entry will not be created and an error will be
142 * raised
143 * @param p_validate If true, then validation alone will be performed and the
144 * database will remain unchanged. If false and all validation checks pass,
145 * then the database will be modified.
146 * @param p_assignment_id Identifies the assignment for which you create the
147 * assignment status history entry record.
148 * @param p_assignment_status_type_id The type of assignment status
149 * @param p_status_change_date The date of the assignment status change
150 * @param p_status_change_reason The reason for the assignment status change
151 * @param p_assignment_status_id If p_validate is false, then this uniquely
152 * identifies the assignment status history entry created. If p_validate is
153 * true, then set to null.
154 * @param p_object_version_number If p_validate is false, then set to the
155 * version number of the created assignment status history entry. If p_validate
156 * is true, then the value will be null.
157 * @rep:displayname Create iRecruitment Assignment Status History Entry
158 * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
159 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
160 * @rep:scope public
161 * @rep:lifecycle active
162 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
163 */
164 --
165 -- {End Of Comments}
166 --
167 procedure create_irc_asg_status
168 (
169 p_validate in boolean default false
170 , p_assignment_id in number
171 , p_assignment_status_type_id in number
172 , p_status_change_date in date
173 , p_status_change_reason in varchar2 default null
174 , p_assignment_status_id out nocopy number
175 , p_object_version_number out nocopy number
176 );
177 --
178 -- ----------------------------------------------------------------------------
179 -- |--------------------------< update_irc_asg_status >-----------------------|
180 -- ----------------------------------------------------------------------------
181 --
182 -- {Start Of Comments}
183 /*#
184 * This API updates an Assignment Status History entry.
185 *
186 * The assignment status history is an audit of all of the changes to an
187 * applicant's assignment status.
188 *
189 * <p><b>Licensing</b><br>
190 * This API is licensed for use with iRecruitment.
191 *
192 * <p><b>Prerequisites</b><br>
193 * The assignment status history entry must already exist.
194 *
195 * <p><b>Post Success</b><br>
196 * The assignment status history entry will be updated in the database
197 *
198 * <p><b>Post Failure</b><br>
199 * The assignment status history entry will not be updated and an error will be
200 * raised
201 * @param p_validate If true, then validation alone will be performed and the
202 * database will remain unchanged. If false and all validation checks pass,
203 * then the database will be modified.
204 * @param p_status_change_reason The reason for the assignment status change
205 * @param p_status_change_date The date of the assignment status change
206 * @param p_assignment_status_id Identifies the assignment status history entry
207 * to be modified
208 * @param p_object_version_number Pass in the current version number of the
209 * assignment status history entry to be updated. When the API completes if
210 * p_validate is false, will be set to the new version number of the updated
211 * assignment status history entry. If p_validate is true will be set to the
212 * same value which was passed in.
213 * @rep:displayname Update iRecruitment Assignment Status History Entry
214 * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
215 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
216 * @rep:scope public
217 * @rep:lifecycle active
218 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
219 */
220 --
221 -- {End Of Comments}
222 --
223 procedure update_irc_asg_status
224 (
225 p_validate in boolean default false
226 , p_status_change_reason in varchar2 default hr_api.g_varchar2
227 , p_status_change_date in date
228 , p_assignment_status_id in number
229 , p_object_version_number in out nocopy number
230 );
231 --
232 -- ----------------------------------------------------------------------------
233 -- |--------------------------< delete_irc_asg_status >-----------------------|
234 -- ----------------------------------------------------------------------------
235 --
236 -- {Start Of Comments}
237 /*#
238 * This API deletes an Assignment Status History entry.
239 *
240 *
241 * <p><b>Licensing</b><br>
242 * This API is licensed for use with iRecruitment.
243 *
244 * <p><b>Prerequisites</b><br>
245 * The assignment status history entry must already exist.
246 *
247 * <p><b>Post Success</b><br>
248 * The assignment status history entry will be deleted from the database
249 *
250 * <p><b>Post Failure</b><br>
251 * The assignment status history entry will not be deleted and an error will be
252 * raised
253 * @param p_validate If true, then validation alone will be performed and the
254 * database will remain unchanged. If false and all validation checks pass,
255 * then the database will be modified.
256 * @param p_assignment_status_id Identifies the assignment status history entry
257 * to be modified
258 * @param p_object_version_number Current version number of the assignment
259 * status history entry to be deleted.
260 * @rep:displayname Delete iRecruitment Assignment Status History Entry
261 * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
262 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
263 * @rep:scope public
264 * @rep:lifecycle active
265 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
266 */
267 --
268 -- {End Of Comments}
269 --
270 procedure delete_irc_asg_status
271 (
272 p_validate in boolean default false
273 , p_assignment_status_id in number
274 , p_object_version_number in number
275 );
276 --
277 end IRC_ASG_STATUS_API;
[Home] [Help]