DBA Data[Home] [Help]

PACKAGE: APPS.IRC_ASG_STATUS_API

Source


1 Package IRC_ASG_STATUS_API AUTHID CURRENT_USER as
2 /* $Header: iriasapi.pkh 120.3 2009/07/30 03:42:26 vmummidi ship $ */
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 --   P_STATUS_CHANGE_COMMENTS     N   varchar2 Status Change Comments
87 --
88 -- Post Success:
89 --   The API creates a primary system status and sets the following out
90 --   parameters
91 --
92 --   Name                           Type     Description
93 --
94 --   P_OBJECT_VERSION_NUMBER        number   After a system status  is created
95 --                                           object version number is set to 1
96 --   P_ASSIGNMENT_STATUS_ID         number   Automatically assignment status
100 --
97 --                                           id is generated by a sequence
98 --
99 -- Post Failure:
101 --   The api does not create/update a assignment status and an error is raised
102 --
103 -- Access Status:
104 --   Internal Use Only
105 --
106 -- {End Of Comments}
107 --
108 procedure dt_update_irc_asg_status
109   (
110     p_validate                  in  boolean  default false
111   , p_datetrack_mode            in  varchar2
112   , p_assignment_id             in  number
113   , p_assignment_status_type_id in  number
114   , p_status_change_date        in  date
115   , p_status_change_reason      in  varchar2 default hr_api.g_varchar2
116   , p_assignment_status_id      out nocopy number
117   , p_object_version_number     out nocopy number
118   , p_status_change_comments    in  varchar2 default hr_api.g_varchar2
119   );
120 --
121 -- ----------------------------------------------------------------------------
122 -- |--------------------------< create_irc_asg_status >-----------------------|
123 -- ----------------------------------------------------------------------------
124 --
125 -- {Start Of Comments}
126 /*#
127  * This API creates an Assignment Status History entry.
128  *
129  * The assignment status history is an audit of all of the changes to an
130  * applicant's assignment status.
131  *
132  * <p><b>Licensing</b><br>
133  * This API is licensed for use with iRecruitment.
134  *
135  * <p><b>Prerequisites</b><br>
136  * A valid assignment is required for creating an assignment status history
137  * entry
138  *
139  * <p><b>Post Success</b><br>
140  * An assignment status history entry will be created in the database
141  *
142  * <p><b>Post Failure</b><br>
143  * The assignment status history entry will not be created and an error will be
144  * raised
145  * @param p_validate If true, then validation alone will be performed and the
146  * database will remain unchanged. If false and all validation checks pass,
147  * then the database will be modified.
148  * @param p_assignment_id Identifies the assignment for which you create the
149  * assignment status history entry record.
150  * @param p_assignment_status_type_id The type of assignment status
151  * @param p_status_change_date The date of the assignment status change
152  * @param p_status_change_reason The reason for the assignment status change
153  * @param p_assignment_status_id If p_validate is false, then this uniquely
154  * identifies the assignment status history entry created. If p_validate is
155  * true, then set to null.
156  * @param p_object_version_number If p_validate is false, then set to the
157  * version number of the created assignment status history entry. If p_validate
158  * is true, then the value will be null.
159  * @param p_status_change_comments Application status change comments
160  * @rep:displayname Create iRecruitment Assignment Status History Entry
161  * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
162  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
163  * @rep:scope public
164  * @rep:lifecycle active
165  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
166 */
167 --
168 -- {End Of Comments}
169 --
170 procedure create_irc_asg_status
171   (
172     p_validate                  in  boolean  default false
173   , p_assignment_id             in  number
174   , p_assignment_status_type_id in  number
175   , p_status_change_date        in  date
176   , p_status_change_reason      in  varchar2 default null
177   , p_assignment_status_id      out nocopy number
178   , p_object_version_number     out nocopy number
179   , p_status_change_comments    in  varchar2 default null
180   );
181 --
182 -- ----------------------------------------------------------------------------
183 -- |--------------------------< update_irc_asg_status >-----------------------|
184 -- ----------------------------------------------------------------------------
185 --
186 -- {Start Of Comments}
187 /*#
188  * This API updates an Assignment Status History entry.
189  *
190  * The assignment status history is an audit of all of the changes to an
191  * applicant's assignment status.
192  *
193  * <p><b>Licensing</b><br>
194  * This API is licensed for use with iRecruitment.
195  *
196  * <p><b>Prerequisites</b><br>
197  * The assignment status history entry must already exist.
198  *
199  * <p><b>Post Success</b><br>
200  * The assignment status history entry will be updated in the database
201  *
202  * <p><b>Post Failure</b><br>
203  * The assignment status history entry will not be updated and an error will be
204  * raised
205  * @param p_validate If true, then validation alone will be performed and the
206  * database will remain unchanged. If false and all validation checks pass,
207  * then the database will be modified.
208  * @param p_status_change_reason The reason for the assignment status change
209  * @param p_status_change_date The date of the assignment status change
210  * @param p_assignment_status_id Identifies the assignment status history entry
211  * to be modified
212  * @param p_object_version_number Pass in the current version number of the
213  * assignment status history entry to be updated. When the API completes if
214  * p_validate is false, will be set to the new version number of the updated
215  * assignment status history entry. If p_validate is true will be set to the
216  * same value which was passed in.
217  * @param p_status_change_comments Application status change comments
218  * @rep:displayname Update iRecruitment Assignment Status History Entry
219  * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
220  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
221  * @rep:scope public
222  * @rep:lifecycle active
223  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
224 */
228 procedure update_irc_asg_status
225 --
226 -- {End Of Comments}
227 --
229   (
230     p_validate                  in  boolean  default false
231   , p_status_change_reason      in  varchar2 default hr_api.g_varchar2
232   , p_status_change_date        in  date
233   , p_assignment_status_id      in  number
234   , p_object_version_number  in out nocopy number
235   , p_status_change_comments    in  varchar2 default hr_api.g_varchar2
236   );
237 --
238 -- ----------------------------------------------------------------------------
239 -- |--------------------------< delete_irc_asg_status >-----------------------|
240 -- ----------------------------------------------------------------------------
241 --
242 -- {Start Of Comments}
243 /*#
244  * This API deletes an Assignment Status History entry.
245  *
246  *
247  * <p><b>Licensing</b><br>
248  * This API is licensed for use with iRecruitment.
249  *
250  * <p><b>Prerequisites</b><br>
251  * The assignment status history entry must already exist.
252  *
253  * <p><b>Post Success</b><br>
254  * The assignment status history entry will be deleted from the database
255  *
256  * <p><b>Post Failure</b><br>
257  * The assignment status history entry will not be deleted and an error will be
258  * raised
259  * @param p_validate If true, then validation alone will be performed and the
260  * database will remain unchanged. If false and all validation checks pass,
261  * then the database will be modified.
262  * @param p_assignment_status_id Identifies the assignment status history entry
263  * to be modified
264  * @param p_object_version_number Current version number of the assignment
265  * status history entry to be deleted.
266  * @rep:displayname Delete iRecruitment Assignment Status History Entry
267  * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
268  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
269  * @rep:scope public
270  * @rep:lifecycle active
271  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
272 */
273 --
274 -- {End Of Comments}
275 --
276 procedure delete_irc_asg_status
277   (
278     p_validate                  in  boolean  default false
279   , p_assignment_status_id      in  number
280   , p_object_version_number     in  number
281   );
282 --
283 --
284 --
285 -- ----------------------------------------------------------------------------
286 -- |-----------------------------< get_status_change_by >--------------------|
287 -- ----------------------------------------------------------------------------
288 --
289 --
290 function get_status_change_by
291   ( P_EFFECTIVE_DATE               IN   date
292    ,P_ASSIGNMENT_ID      IN   number
293   ) RETURN VARCHAR2;
294 --
295 end  IRC_ASG_STATUS_API;