1 Package ghr_complaint_bases_api as
2 /* $Header: ghcbaapi.pkh 120.1 2005/10/02 01:57:14 aroussel $ */
3 /*#
4 * This package contains the procedures for creating, updating and deleting GHR
5 * Complaints Tracking Complaint Bases records.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Complaint Base
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_compl_basis >------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a Complaints Tracking Complaint Basis record.
18 *
19 * This API creates a child Basis record in table ghr_compl_bases for an
20 * existing parent Claim.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * A parent Claim record must exist in ghr_compl_claims.
27 *
28 * <p><b>Post Success</b><br>
29 * The API creates the Basis record in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The API does not create the Basis record and an error is raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_compl_claim_id Uniquely identifies the Parent Claim record.
40 * @param p_basis Claim Basis Category. Valid values are defined by the
41 * 'GHR_US_BASIS_CATEGORY' lookup type.
42 * @param p_value Claim Basis Value. Valid values are derived by the
43 * 'GHR_US_BASIS_CATEGORY' lookup type code value selected in Claim Bases.
44 * @param p_statute Basis Statute. Valid values are defined by
45 * 'GHR_US_BASIS_STATUTE' lookup type.
46 * @param p_agency_finding Basis Agency Finding. Valid values are defined by
47 * 'GHR_US_FINDING' lookup type.
48 * @param p_aj_finding Basis Administrative Judge (AJ) Finding. Valid values
49 * are defined by 'GHR_US_FINDING' lookup type.
50 * @param p_compl_basis_id If p_validate is false, then this uniquely
51 * identifies the Basis created. If p_validate is true, then set to null.
52 * @param p_object_version_number If p_validate is false, then set to the
53 * version number of the created Basis. If p_validate is true, then the value
54 * will be null.
55 * @rep:displayname Create Complaint Basis
56 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
57 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:scope public
59 * @rep:lifecycle active
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_compl_basis
66 (p_validate in boolean default false
67 ,p_effective_date in date
68 ,p_compl_claim_id in number
69 ,p_basis in varchar2 default null
70 ,p_value in varchar2 default null
71 ,p_statute in varchar2 default null
72 ,p_agency_finding in varchar2 default null
73 ,p_aj_finding in varchar2 default null
74 ,p_compl_basis_id out nocopy number
75 ,p_object_version_number out nocopy number
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |----------------------------< update_compl_basis >------------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates a Complaints Tracking Complaint Basis record.
85 *
86 * This API updates a child Basis record in table ghr_compl_bases for an
87 * existing parent Claim.
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Human Resources.
91 *
92 * <p><b>Prerequisites</b><br>
93 * A parent Claim record must exist in ghr_compl_claims.
94 *
95 * <p><b>Post Success</b><br>
96 * The API updates the Basis record in the database.
97 *
98 * <p><b>Post Failure</b><br>
99 * The API does not update the Basis record and an error is raised.
100 * @param p_validate If true, then validation alone will be performed and the
101 * database will remain unchanged. If false and all validation checks pass,
102 * then the database will be modified.
103 * @param p_effective_date Reference date for validating lookup values are
104 * applicable during the start to end active date range. This date does not
105 * determine when the changes take effect.
106 * @param p_compl_basis_id Uniquely identifies the Basis record to be updated.
107 * @param p_compl_claim_id Uniquely identifies the Parent Claim record.
108 * @param p_basis Claim Basis Category. Valid values are defined by
109 * 'GHR_US_BASIS_CATEGORY' lookup type.
110 * @param p_value Claim Basis Value. Valid values are derived by the
111 * 'GHR_US_BASIS_CATEGORY' lookup type code value selected in Claim Bases.
112 * @param p_statute Basis Statute. Valid values are defined by
113 * 'GHR_US_BASIS_STATUTE' lookup type.
114 * @param p_agency_finding Basis Agency Finding. Valid values are defined by
115 * 'GHR_US_FINDING' lookup type.
116 * @param p_aj_finding Basis Administrative Judge (AJ) Finding. Valid values
117 * are defined by 'GHR_US_FINDING' lookup type.
118 * @param p_object_version_number Pass in the current version number of the
119 * Basis to be updated. When the API completes if p_validate is false, will be
120 * set to the new version number of the updated Basis. If p_validate is true
121 * will be set to the same value which was passed in.
122 * @rep:displayname Update Complaint Basis
123 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
124 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
125 * @rep:scope public
126 * @rep:lifecycle active
127 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
128 */
129 --
130 -- {End Of Comments}
131 --
132 procedure update_compl_basis
133 (p_validate in boolean default false
134 ,p_effective_date in date
135 ,p_compl_basis_id in number
136 ,p_compl_claim_id in number default hr_api.g_number
137 ,p_basis in varchar2 default hr_api.g_varchar2
138 ,p_value in varchar2 default hr_api.g_varchar2
139 ,p_statute in varchar2 default hr_api.g_varchar2
140 ,p_agency_finding in varchar2 default hr_api.g_varchar2
141 ,p_aj_finding in varchar2 default hr_api.g_varchar2
142 ,p_object_version_number in out nocopy number
143 );
144 --
145 -- ----------------------------------------------------------------------------
146 -- |----------------------------< delete_compl_basis >------------------------|
147 -- ----------------------------------------------------------------------------
148 --
149 -- {Start Of Comments}
150 /*#
151 * This API deletes a Complaints Tracking Complaint Basis record.
152 *
153 * This API deletes a child Basis record from table ghr_compl_bases for an
154 * existing parent Claim.
155 *
156 * <p><b>Licensing</b><br>
157 * This API is licensed for use with Human Resources.
158 *
159 * <p><b>Prerequisites</b><br>
160 * The Complaint Basis record specified must exist.
161 *
162 * <p><b>Post Success</b><br>
163 * The API deletes the Basis record in the database.
164 *
165 * <p><b>Post Failure</b><br>
166 * The API does not delete the Basis record and an error is raised.
167 * @param p_validate If true, then validation alone will be performed and the
168 * database will remain unchanged. If false and all validation checks pass,
169 * then the database will be modified.
170 * @param p_compl_basis_id Uniquely identifies the Basis record to be deleted.
171 * @param p_object_version_number Current version number of the Basis to be
172 * deleted.
173 * @rep:displayname Delete Complaint Basis
174 * @rep:category BUSINESS_ENTITY GHR_EEO_COMPLAINT
175 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
176 * @rep:scope public
177 * @rep:lifecycle active
178 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
179 */
180 --
181 -- {End Of Comments}
182 --
183 procedure delete_compl_basis
184 (p_validate in boolean default false
185 ,p_compl_basis_id in number
186 ,p_object_version_number in number
187 );
188 --
189 end ghr_complaint_bases_api;
[Home] [Help]