1 Package ghr_pa_remarks_api AUTHID CURRENT_USER as
2 /* $Header: ghpreapi.pkh 120.3 2006/07/07 12:43:15 vnarasim noship $ */
3 /*#
4 * This package contains the procedures for creating, updating, and deleting
5 * Request for Personnel Action (RPA) Remarks where the user has entered
6 * insertion values.
7 * @rep:scope public
8 * @rep:product per
9 * @rep:displayname Request for Personnel Action Remark
10 */
11 --
12 -- ----------------------------------------------------------------------------
13 -- |----------------------------< create_pa_remarks >-------------------------|
14 -- ----------------------------------------------------------------------------
15 --
16 -- {Start Of Comments}
17 /*#
18 * This API creates a Request for Personnel Action (RPA) Remark record.
19 *
20 * This API creates a Request for Personnel Action (RPA) Remark record
21 * containing a user entered insertion value in the GHR_pa_remarks table.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Human Resources.
25 *
26 * <p><b>Prerequisites</b><br>
27 * A parent pa request id record must exist in GHR_pa_requests and remark_id
28 * must exist in GHR_remarks.
29 *
30 * <p><b>Post Success</b><br>
31 * The API creates the Request for Personnel Action (RPA) Remark record in the
32 * database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The API does not create the Request for Personnel Action (RPA) Remark record
36 * and an error is raised.
37 * @param p_validate If true, then validation alone will be performed and the
38 * database will remain unchanged. If false and all validation checks pass,
39 * then the database will be modified.
40 * @param p_pa_request_id {@rep:casecolumn GHR_PA_REQUESTS.PA_REQUEST_ID}
41 * @param p_remark_id {@rep:casecolumn GHR_REMARKS.REMARK_ID}
42 * @param p_description {@rep:casecolumn GHR_PA_REMARKS.DESCRIPTION}
43 * @param p_remark_code_information1 {@rep:casecolumn
44 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION1}
45 * @param p_remark_code_information2 {@rep:casecolumn
46 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION2}
47 * @param p_remark_code_information3 {@rep:casecolumn
48 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION3}
49 * @param p_remark_code_information4 {@rep:casecolumn
50 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION4}
51 * @param p_remark_code_information5 {@rep:casecolumn
52 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION5}
53 * @param p_pa_remark_id If p_validate is false, then this uniquely identifies
54 * the Request for Personnel Action (RPA) Remark record created. If p_validate
55 * is true, then set to null.
56 * @param p_object_version_number If p_validate is false, then set to the
57 * version number of the created Personnel Action_remark_id. If p_validate is
58 * true, then the value will be null.
59 * @rep:displayname Create Request for Personnel Action Remark
60 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
61 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
62 * @rep:scope public
63 * @rep:lifecycle active
64 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
65 */
66 --
67 -- {End Of Comments}
68 --
69 procedure create_pa_remarks
70 (p_validate in boolean default false
71 ,p_pa_request_id in number
72 ,p_remark_id in number
73 ,p_description in varchar2 default null
74 ,p_remark_code_information1 in varchar2 default null
75 ,p_remark_code_information2 in varchar2 default null
76 ,p_remark_code_information3 in varchar2 default null
77 ,p_remark_code_information4 in varchar2 default null
78 ,p_remark_code_information5 in varchar2 default null
79 ,p_pa_remark_id out nocopy number
80 ,p_object_version_number out nocopy number
81 );
82 --
83 -- ----------------------------------------------------------------------------
84 -- |----------------------------< update_pa_remarks >-------------------------|
85 -- ----------------------------------------------------------------------------
86 --
87 -- {Start Of Comments}
88 /*#
89 * This API updates the Request for Personnel Action (RPA) Remark record in the
90 * GHR_pa_remarks table.
91 *
92 * This API updates the Request for Personnel Action (RPA) Remark record
93 * containing a user entered insertion value in the GHR_pa_remarks table.
94 *
95 * <p><b>Licensing</b><br>
96 * This API is licensed for use with Human Resources.
97 *
98 * <p><b>Prerequisites</b><br>
99 * A parent pa request id record must exist in GHR_pa_requests and remark_id
100 * must exist in GHR_remarks.
101 *
102 * <p><b>Post Success</b><br>
103 * The API updates the Request for Personnel Action (RPA) Remark record in the
104 * database.
105 *
106 * <p><b>Post Failure</b><br>
107 * The API does not update the Request for Personnel Action (RPA) Remark record
108 * and an error is raised.
109 * @param p_validate If true, then validation alone will be performed and the
110 * database will remain unchanged. If false and all validation checks pass,
111 * then the database will be modified.
112 * @param p_pa_remark_id Uniquely identifies the Request for Personnel Action
113 * (RPA) Remark record.
114 * @param p_object_version_number Pass in the current version number of the
115 * Personnel Action_remark_id to be updated. When the API completes if
116 * p_validate is false, will be set to the new version number of the updated
117 * Personnel Action_remark_id. If p_validate is true will be set to the same
118 * value which was passed in.
119 * @param p_remark_code_information1 {@rep:casecolumn
120 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION1}
121 * @param p_remark_code_information2 {@rep:casecolumn
122 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION2}
123 * @param p_remark_code_information3 {@rep:casecolumn
124 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION3}
125 * @param p_remark_code_information4 {@rep:casecolumn
126 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION4}
127 * @param p_remark_code_information5 {@rep:casecolumn
128 * GHR_PA_REMARKS.REMARK_CODE_INFORMATION5}
129 * @param p_description {@rep:casecolumn GHR_PA_REMARKS.DESCRIPTION}
130 * @rep:displayname Update Request for Personnel Action Remark
131 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
132 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
133 * @rep:scope public
134 * @rep:lifecycle active
135 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
136 */
137 --
138 -- {End Of Comments}
139 --
140 procedure update_pa_remarks
141 (p_validate in boolean default false
142 ,p_pa_remark_id in number
143 ,p_object_version_number in out nocopy number
147 ,p_remark_code_information4 in varchar2 default hr_api.g_varchar2
144 ,p_remark_code_information1 in varchar2 default hr_api.g_varchar2
145 ,p_remark_code_information2 in varchar2 default hr_api.g_varchar2
146 ,p_remark_code_information3 in varchar2 default hr_api.g_varchar2
148 ,p_remark_code_information5 in varchar2 default hr_api.g_varchar2
149 ,p_description in varchar2 default hr_api.g_varchar2
150 );
151 --
152 -- ----------------------------------------------------------------------------
153 -- |----------------------------< delete_pa_remarks >-------------------------|
154 -- ----------------------------------------------------------------------------
155 --
156 -- {Start Of Comments}
157 /*#
158 * This API deletes the Request for Personnel Action (RPA) Remark record from
159 * the GHR_pa_remarks table.
160 *
161 * This API deletes the Request for Personnel Action (RPA) Remark record
162 * containing a user entered insertion value from the GHR_pa_remarks table.
163 *
164 * <p><b>Licensing</b><br>
165 * This API is licensed for use with Human Resources.
166 *
167 * <p><b>Prerequisites</b><br>
168 * The Personnel Action Remark record specified must exist.
169 *
170 * <p><b>Post Success</b><br>
171 * The Request for Personnel Action (RPA) Remark record is deleted from the
172 * database.
173 *
174 * <p><b>Post Failure</b><br>
175 * The API does not delete the Request for Personnel Action (RPA) Remark record
176 * and an error is raised.
177 * @param p_validate If true, then validation alone will be performed and the
178 * database will remain unchanged. If false and all validation checks pass,
179 * then the database will be modified.
180 * @param p_pa_remark_id Uniquely identifies the Request for Personnel Action
181 * (RPA) Remark record.
182 * @param p_object_version_number Current version number of the Request for
183 * Personnel Action (RPA) Remark record to be deleted.
184 * @rep:displayname Delete Request for Personnel Action Remark
185 * @rep:category BUSINESS_ENTITY GHR_REQ_FOR_PERSONNEL_ACTION
186 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
187 * @rep:scope public
188 * @rep:lifecycle active
189 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
190 */
191 --
192 -- {End Of Comments}
193 --
194 procedure delete_pa_remarks
195 (p_validate in boolean default false
196 ,p_pa_remark_id in number
197 ,p_object_version_number in number
198 );
199 end ghr_pa_remarks_api;
[Home] [Help]