1 Package IRC_OFFER_STATUS_HISTORY_API AUTHID CURRENT_USER as
2 /* $Header: iriosapi.pkh 120.8 2008/02/21 14:19:25 viviswan noship $ */
3 /*#
4 * This package contains APIs for maintaining offer status history.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Offer Status History
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_offer_status_history >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new offer status history.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with iRecruitment.
21 *
22 * <p><b>Prerequisites</b><br>
23 * None
24 *
25 * <p><b>Post Success</b><br>
26 * A new record is successfully inserted.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create an offer status history and raises an error.
30 *
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Determines when the DateTrack operation comes
35 * into force.
36 * @param p_offer_id The associated offer ID for
37 * this status history record.
38 * @param p_status_change_date The date on which the offer status was changed.
39 * @param p_offer_status The offer status for the record.
40 * @param p_change_reason The reason for the change in the offer status.
41 * @param p_decline_reason The reason for declining the offer.
42 * @param p_note_text Offer notes text.
43 * @param p_offer_status_history_id Primary key of the offer status history in
44 * IRC_OFFER_STATUS_HISTORY table.
45 * @param p_object_version_number If p_validate is false, then set to the
46 * version number of the created assignment detail. If p_validate is true,
47 * then the value will be null.
48 * @rep:displayname Create Offer Status History
49 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER
50 * @rep:lifecycle active
51 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
52 * @rep:scope public
53 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
54 */
55 --
56 -- {End Of Comments}
57 --
58 procedure create_offer_status_history
59 ( P_VALIDATE IN boolean default false
60 ,P_EFFECTIVE_DATE IN DATE default null
61 ,P_OFFER_ID IN NUMBER
62 ,P_STATUS_CHANGE_DATE IN DATE default null
63 ,P_OFFER_STATUS IN VARCHAR2
64 ,P_CHANGE_REASON IN VARCHAR2 default null
65 ,P_DECLINE_REASON IN VARCHAR2 default null
66 ,P_NOTE_TEXT IN VARCHAR2 default null
67 ,P_OFFER_STATUS_HISTORY_ID OUT nocopy NUMBER
68 ,P_OBJECT_VERSION_NUMBER OUT nocopy NUMBER
69 );
70 --
71 -- ----------------------------------------------------------------------------
72 -- |-----------------------< update_offer_status_history >--------------------|
73 -- ----------------------------------------------------------------------------
74 --
75 -- {Start Of Comments}
76 /*#
77 * This API updates an offer status history record.
78 *
79 *
80 * <p><b>Licensing</b><br>
81 * This API is licensed for use with iRecruitment.
82 *
83 * <p><b>Prerequisites</b><br>
84 * The offer status history must exist.
85 *
86 * <p><b>Post Success</b><br>
87 * The record gets successfully updated.
88 *
89 * <p><b>Post Failure</b><br>
90 * The API does not update the offer and an error will be raised.
91 *
92 * @param p_validate If true, then validation alone will be performed and the
93 * database will remain unchanged. If false and all validation checks pass,
94 * then the database will be modified.
95 * @param p_effective_date Determines when the DateTrack operation comes into
96 * force.
97 * @param p_offer_status_history_id Primary key of the offer status history in
98 * IRC_OFFER_STATUS_HISTORY table.
99 * @param p_offer_id The associated Offer ID for
100 * this status history record.
101 * @param p_status_change_date The date on which the offer status was changed.
102 * @param p_offer_status The offer status for the record.
103 * @param p_change_reason The reason for the change in the offer status.
104 * @param p_decline_reason The reason for declining the offer.
105 * @param p_note_text Offer Notes Text.
106 * @param p_object_version_number Pass in the current version number of the
107 * note to be updated. When the API completes if p_validate is
108 * false, will be set to the new version number of the updated note.
109 * If p_validate is true will be set to the same value which was
110 * passed in.
111 * @rep:displayname Update Offer Status History
112 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER
113 * @rep:lifecycle active
114 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
115 * @rep:scope public
116 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
117 */
118 --
119 -- {End Of Comments}
120 --
121 procedure update_offer_status_history
122 ( P_VALIDATE IN boolean default false
123 ,P_EFFECTIVE_DATE IN DATE default null
124 ,P_OFFER_STATUS_HISTORY_ID IN NUMBER
125 ,P_OFFER_ID IN NUMBER
126 ,P_STATUS_CHANGE_DATE IN DATE
127 ,P_OFFER_STATUS IN VARCHAR2
128 ,P_CHANGE_REASON IN VARCHAR2 default null
129 ,P_DECLINE_REASON IN VARCHAR2 default null
130 ,P_NOTE_TEXT IN VARCHAR2 default null
131 ,P_OBJECT_VERSION_NUMBER IN OUT nocopy NUMBER
132 );
133 --
134 -- ----------------------------------------------------------------------------
135 -- |-----------------------< delete_offer_status_history >--------------------|
136 -- ----------------------------------------------------------------------------
137 --
138 -- {Start Of Comments}
139 /*#
140 * This API deletes an offer status history record.
141 *
142 *
143 * <p><b>Licensing</b><br>
144 * This API is licensed for use with iRecruitment.
145 *
146 * <p><b>Prerequisites</b><br>
147 * The offer status history must exist.
148 *
149 * <p><b>Post Success</b><br>
150 * The current offer status history record will be deleted.
151 *
152 * <p><b>Post Failure</b><br>
153 * The record will not be deleted and an error is raised.
154 *
155 * @param p_validate If true, then validation alone will be performed and the
156 * database will remain unchanged. If false and all validation checks pass,
157 * then the database will be modified.
158 * @param p_offer_id The associated offer ID for
159 * this status history record.
160 * @param p_effective_date Determines when the DateTrack operation comes into
161 * force.
162 * @rep:displayname Delete Offer Status History
163 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER
164 * @rep:lifecycle active
165 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
166 * @rep:scope public
167 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
168 */
169 --
170 -- {End Of Comments}
171 --
172 procedure delete_offer_status_history
173 ( P_VALIDATE IN boolean default false
174 ,P_OFFER_ID IN NUMBER
175 ,P_EFFECTIVE_DATE IN DATE
176 );
177 --
178 end IRC_OFFER_STATUS_HISTORY_API;
[Home] [Help]