1 Package IRC_NOTES_API AUTHID CURRENT_USER as
2 /* $Header: irinoapi.pkh 120.3 2008/02/21 14:14:34 viviswan noship $ */
3 /*#
4 * This package contains APIs to maintain notes for offers.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Note
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_note >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates new records in the IRC_NOTES table.
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 * The offer_status_history_id should exist in IRC_OFFER_STATUS_HISTORY table.
24 *
25 * <p><b>Post Success</b><br>
26 * Sucessfully inserts a new record in the IRC_NOTES table.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the record in the IRC_NOTES table and
30 * raises an error.
31 *
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_offer_status_history_id Identifies the record in the
36 * IRC_OFFER_STATUS_HISTORY table.
37 * @param p_note_text The offer notes text.
38 * @param p_note_id Primary key of the note in the IRC_NOTES table.
39 * @param p_object_version_number If p_validate is false, then set to the
40 * version number of the created assignment detail. If p_validate is true,
41 * then the value will be null.
42 * @rep:displayname Create Note
43 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_NOTES
44 * @rep:lifecycle active
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
48 */
49 --
50 -- {End Of Comments}
51 --
52 procedure CREATE_NOTE
53 (p_validate in boolean default false
54 ,p_offer_status_history_id in number
55 ,p_note_text in varchar2
56 ,p_note_id out nocopy number
57 ,p_object_version_number out nocopy number
58 );
59 --
60 --
61 -- ----------------------------------------------------------------------------
62 -- |-------------------------------< update_note >----------------------------|
63 -- ----------------------------------------------------------------------------
64 --
65 -- {Start Of Comments}
66 /*#
67 * This API updates records in the IRC_NOTES table.
68 *
69 *
70 * <p><b>Licensing</b><br>
71 * This API is licensed for use with iRecruitment.
72 *
73 * <p><b>Prerequisites</b><br>
74 * The note_id must exist in IRC_NOTES table.
75 *
76 * <p><b>Post Success</b><br>
77 * The record in the IRC_NOTES will be successfully updated.
78 *
79 * <p><b>Post Failure</b><br>
80 * The API does not update the record and raises an error.
81 *
82 * @param p_validate If true, then validation alone will be performed and the
83 * database will remain unchanged. If false and all validation checks pass,
84 * then the database will be modified.
85 *
86 * @param p_note_id Identifies the note in the IRC_NOTES table.
87 * @param p_offer_status_history_id Identifies the record in the
88 * IRC_OFFER_STATUS_HISTORY table.
89 * @param p_note_text The text of the offer note.
90 * @param p_object_version_number Pass in the current version number of the
91 * note to be updated. When the API completes if p_validate is
92 * false, will be set to the new version number of the updated note.
93 * If p_validate is true will be set to the same value which was
94 * passed in.
95 * @rep:displayname Update Note
96 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_NOTES
97 * @rep:lifecycle active
98 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
99 * @rep:scope public
100 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
101 */
102 --
103 -- {End Of Comments}
104 --
105 procedure UPDATE_NOTE
106 (p_validate in boolean default false
107 ,p_note_id in number
108 ,p_offer_status_history_id in number default hr_api.g_number
109 ,p_note_text in varchar2 default hr_api.g_varchar2
110 ,p_object_version_number in out nocopy number
111 );
112 --
113 -- ----------------------------------------------------------------------------
114 -- |-------------------------------< delete_note >----------------------------|
115 -- ----------------------------------------------------------------------------
116 --
117 -- {Start Of Comments}
118 /*#
119 * This API deletes records from the IRC_NOTES table.
120 *
121 *
122 * <p><b>Licensing</b><br>
123 * This API is licensed for use with iRecruitment.
124 *
125 * <p><b>Prerequisites</b><br>
126 * The notes_id must exist in IRC_NOTES table.
127 *
128 * <p><b>Post Success</b><br>
129 * The record will be deleted
130 *
131 * <p><b>Post Failure</b><br>
132 * The record will not be deleted and an error is raised.
133 *
134 * @param p_validate If true, then validation alone will be performed and the
135 * database will remain unchanged. If false and all validation checks pass,
136 * then the database will be modified.
137 * @param p_note_id Identifies the note in the IRC_NOTES table.
138 * @param p_object_version_number Current version number of the note to
139 * be deleted.
140 * @rep:displayname Delete Note
141 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_NOTES
142 * @rep:lifecycle active
143 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
144 * @rep:scope public
145 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
146 */
147 --
148 -- {End Of Comments}
149 --
150 procedure DELETE_NOTE
151 (p_validate in boolean default false
152 ,p_note_id in number
153 ,p_object_version_number in number
154 );
155 --
156 end IRC_NOTES_API;
[Home] [Help]