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