[Home] [Help]
PACKAGE: APPS.HZ_ORGANIZATION_INFO_V2PUB
Source
1 PACKAGE HZ_ORGANIZATION_INFO_V2PUB AS
2 /* $Header: ARH2OISS.pls 120.7 2006/08/17 10:13:41 idali noship $ */
3 /*#
4 * This package contains the public APIs for Organization-related entities.
5 * @rep:scope public
6 * @rep:product HZ
7 * @rep:displayname Organization Information
8 * @rep:category BUSINESS_ENTITY HZ_ORGANIZATION
9 * @rep:lifecycle active
10 * @rep:doccd 120hztig.pdf Organization Information APIs, Oracle Trading Community Architecture Technical Implementation Guide
11 */
12
13 --------------------------------------
14 -- declaration of record type
15 --------------------------------------
16
17 TYPE financial_report_rec_type IS RECORD(
18 financial_report_id NUMBER,
19 party_id NUMBER,
20 type_of_financial_report VARCHAR2(60),
21 document_reference VARCHAR2(150),
22 date_report_issued DATE,
23 issued_period VARCHAR2(60),
24 report_start_date DATE,
25 report_end_date DATE,
26 actual_content_source VARCHAR2(30),
27 requiring_authority VARCHAR2(60),
28 audit_ind VARCHAR2(30),
29 consolidated_ind VARCHAR2(30),
30 estimated_ind VARCHAR2(30),
31 fiscal_ind VARCHAR2(30),
32 final_ind VARCHAR2(30),
33 forecast_ind VARCHAR2(30),
34 opening_ind VARCHAR2(30),
35 proforma_ind VARCHAR2(30),
36 qualified_ind VARCHAR2(30),
37 restated_ind VARCHAR2(30),
38 signed_by_principals_ind VARCHAR2(30),
39 trial_balance_ind VARCHAR2(30),
40 unbalanced_ind VARCHAR2(30),
41 status VARCHAR2(30),
42 created_by_module VARCHAR2(150)
43 );
44
45 TYPE financial_number_rec_type IS RECORD (
46 financial_number_id NUMBER,
47 financial_report_id NUMBER,
48 financial_number NUMBER,
49 financial_number_name VARCHAR2(60),
50 financial_units_applied NUMBER,
51 financial_number_currency VARCHAR2(240),
52 projected_actual_flag VARCHAR2(1),
53 content_source_type VARCHAR2(30),
54 status VARCHAR2(1),
55 created_by_module VARCHAR2(150)
56 );
57
58 --------------------------------------
59 -- declaration of public procedures and functions
60 --------------------------------------
61
62 /**
63 * PROCEDURE create_financial_report
64 *
65 * DESCRIPTION
66 * Creates financial report.
67 *
68 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
69 *
70 * ARGUMENTS
71 * IN:
72 * p_init_msg_list Initialize message stack if it is set to
73 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
74 * p_financial_report_rec Financial report record.
75 * IN/OUT:
76 * OUT:
77 * x_financial_report_id Financial report ID.
78 * x_return_status Return status after the call. The status can
79 * be FND_API.G_RET_STS_SUCCESS (success),
80 * FND_API.G_RET_STS_ERROR (error),
81 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
82 * x_msg_count Number of messages in message stack.
83 * x_msg_data Message text if x_msg_count is 1.
84 *
85 * NOTES
86 *
87 * MODIFICATION HISTORY
88 *
89 * 23-JAN-2003 Sreedhar Mohan o Created.
90 *
91 */
92
93 /*#
94 * Use this routine to store a financial report for an organization. The API creates a
95 * record in the HZ_FINANCIAL_REPORTS table.
96 * @rep:scope public
97 * @rep:lifecycle active
98 * @rep:displayname Create Financial Report
99 * @rep:businessevent oracle.apps.ar.hz.FinancialReport.create
100 * @rep:doccd 120hztig.pdf Organization Information APIs, Oracle Trading Community Architecture Technical Implementation Guide
101 */
102 PROCEDURE create_financial_report(
103 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
104 p_financial_report_rec IN FINANCIAL_REPORT_REC_TYPE,
105 x_financial_report_id OUT NOCOPY NUMBER,
106 x_return_status OUT NOCOPY VARCHAR2,
107 x_msg_count OUT NOCOPY NUMBER,
108 x_msg_data OUT NOCOPY VARCHAR2
109 );
110
111 /**
112 * PROCEDURE update_financial_report
113 *
114 * DESCRIPTION
115 * Update financial report.
116 *
117 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
118 *
119 * ARGUMENTS
120 * IN:
121 * p_init_msg_list Initialize message stack if it is set to
122 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
123 * p_financial_report_rec Financial report record.
124 * IN/OUT:
125 * p_object_version_number Used for locking the being updated record.
126 * OUT:
127 * x_financial_report_id Financial report ID.
128 * x_return_status Return status after the call. The status can
129 * be FND_API.G_RET_STS_SUCCESS (success),
130 * FND_API.G_RET_STS_ERROR (error),
131 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
132 * x_msg_count Number of messages in message stack.
133 * x_msg_data Message text if x_msg_count is 1.
134 *
135 * NOTES
136 *
137 * MODIFICATION HISTORY
138 *
139 * 23-JAN-2003 Sreedhar Mohan o Created.
140 *
141 */
142
143 /*#
144 * Use this routine to update a financial report for an organization.
145 * @rep:scope public
146 * @rep:lifecycle active
147 * @rep:displayname Update Financial Report
148 * @rep:businessevent oracle.apps.ar.hz.FinancialReport.update
149 * @rep:doccd 120hztig.pdf Organization Information APIs, Oracle Trading Community Architecture Technical Implementation Guide
150 */
151 PROCEDURE update_financial_report(
152 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
153 p_financial_report_rec IN FINANCIAL_REPORT_REC_TYPE,
154 p_object_version_number IN OUT NOCOPY NUMBER,
155 x_return_status OUT NOCOPY VARCHAR2,
156 x_msg_count OUT NOCOPY NUMBER,
157 x_msg_data OUT NOCOPY VARCHAR2
158 );
159
160
161 /**
162 * PROCEDURE create_financial_number
163 *
164 * DESCRIPTION
165 * Creates financial number.
166 *
167 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
168 *
169 * ARGUMENTS
170 * IN:
171 * p_init_msg_list Initialize message stack if it is set to
172 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
173 * p_financial_number_rec Financial Number record.
174 * IN/OUT:
175 * OUT:
176 * x_financial_number_id Financial Number Id.
177 * x_return_status Return status after the call. The status can
178 * be FND_API.G_RET_STS_SUCCESS (success),
179 * FND_API.G_RET_STS_ERROR (error),
180 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
181 * x_msg_count Number of messages in message stack.
182 * x_msg_data Message text if x_msg_count is 1.
183 *
184 * NOTES
185 *
186 * MODIFICATION HISTORY
187 *
188 * 23-JAN-2003 Sreedhar Mohan o Created.
189 *
190 */
191
192 /*#
193 * Use this routine to store financial numbers for an organization. The API creates a record in the HZ_FINANCIAL_NUMBERS table.
194 * @rep:scope public
195 * @rep:lifecycle active
196 * @rep:displayname Create Financial Number
197 * @rep:businessevent oracle.apps.ar.hz.FinancialNumber.create
198 * @rep:doccd 120hztig.pdf Organization Information APIs, Oracle Trading Community Architecture Technical Implementation Guide
199 */
200 PROCEDURE create_financial_number(
201 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
202 p_financial_number_rec IN FINANCIAL_NUMBER_REC_TYPE,
203 x_financial_number_id OUT NOCOPY NUMBER,
204 x_return_status OUT NOCOPY VARCHAR2,
205 x_msg_count OUT NOCOPY NUMBER,
206 x_msg_data OUT NOCOPY VARCHAR2
207 );
208
209 /**
210 * PROCEDURE update_financial_number
211 *
212 * DESCRIPTION
213 * Updates financial_number.
214 *
215 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
216 *
217 * ARGUMENTS
218 * IN:
219 * p_init_msg_list Initialize message stack if it is set to
220 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
221 * p_financial_number_rec Financial Number record.
222 * IN/OUT:
223 * p_object_version_number Used for locking the being updated record.
224 * OUT:
225 * x_financial_number_id Financial Number Id.
226 * x_return_status Return status after the call. The status can
227 * be FND_API.G_RET_STS_SUCCESS (success),
228 * FND_API.G_RET_STS_ERROR (error),
229 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
230 * x_msg_count Number of messages in message stack.
231 * x_msg_data Message text if x_msg_count is 1.
232 *
233 * NOTES
234 *
235 * MODIFICATION HISTORY
236 *
237 * 23-JAN-2003 Sreedhar Mohan o Created.
238 *
239 */
240
241 /*#
242 * Use this routine to store financial numbers for an organization
243 * @rep:scope public
244 * @rep:lifecycle active
245 * @rep:displayname Update Financial Number
246 * @rep:businessevent oracle.apps.ar.hz.FinancialNumber.update
247 * @rep:doccd 120hztig.pdf Organization Information APIs, Oracle Trading Community Architecture Technical Implementation Guide
248 */
249 PROCEDURE update_financial_number(
250 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
251 p_financial_number_rec IN FINANCIAL_NUMBER_REC_TYPE,
252 p_object_version_number IN OUT NOCOPY NUMBER,
253 x_return_status OUT NOCOPY VARCHAR2,
254 x_msg_count OUT NOCOPY NUMBER,
255 x_msg_data OUT NOCOPY VARCHAR2
256 );
257
258 /**
259 * PROCEDURE get_financial_report_rec
260 *
261 * DESCRIPTION
262 * Gets financial report rec.
263 *
264 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
265 *
266 * ARGUMENTS
267 * IN:
268 * p_init_msg_list Initialize message stack if it is set to
269 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
270 * p_financial_report_id Financial Report Id.
271 * IN/OUT:
272 * OUT:
273 * x_financial_report_rec Financial Report Record.
274 * x_return_status Return status after the call. The status can
275 * be FND_API.G_RET_STS_SUCCESS (success),
276 * FND_API.G_RET_STS_ERROR (error),
277 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
278 * x_msg_count Number of messages in message stack.
279 * x_msg_data Message text if x_msg_count is 1.
280 *
281 * NOTES
282 *
283 * MODIFICATION HISTORY
284 *
285 * 23-JAN-2003 Sreedhar Mohan o Created.
286 *
287 */
288
289 PROCEDURE get_financial_report_rec (
290 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
291 p_financial_report_id IN NUMBER,
292 p_financial_report_rec OUT NOCOPY FINANCIAL_REPORT_REC_TYPE,
293 x_return_status OUT NOCOPY VARCHAR2,
294 x_msg_count OUT NOCOPY NUMBER,
295 x_msg_data OUT NOCOPY VARCHAR2
296 );
297
298 /**
299 * PROCEDURE get_financial_number_rec
300 *
301 * DESCRIPTION
302 * Gets financial number rec.
303 *
304 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
305 *
306 * ARGUMENTS
307 * IN:
308 * p_init_msg_list Initialize message stack if it is set to
309 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
310 * p_financial_number_id Financial number Id.
311 * IN/OUT:
312 * OUT:
313 * x_financial_number_rec Financial Number Record.
314 * x_return_status Return status after the call. The status can
315 * be FND_API.G_RET_STS_SUCCESS (success),
316 * FND_API.G_RET_STS_ERROR (error),
317 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
321 * NOTES
318 * x_msg_count Number of messages in message stack.
319 * x_msg_data Message text if x_msg_count is 1.
320 *
322 *
323 * MODIFICATION HISTORY
324 *
325 * 23-JAN-2003 Sreedhar Mohan o Created.
326 *
327 */
328
329 PROCEDURE get_financial_number_rec (
330 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
331 p_financial_number_id IN NUMBER,
332 p_financial_number_rec OUT NOCOPY FINANCIAL_NUMBER_REC_TYPE,
333 x_return_status OUT NOCOPY VARCHAR2,
334 x_msg_count OUT NOCOPY NUMBER,
335 x_msg_data OUT NOCOPY VARCHAR2
336 );
337
338 END HZ_ORGANIZATION_INFO_V2PUB;