1 package pa_purge_extn AUTHID CURRENT_USER as
2 /* $Header: PAXAPPXS.pls 120.3 2006/07/05 09:14:23 vgottimu noship $ */
3 /*#
4 * This package contains the extensions to purge your custom tables. By default the extension
5 * returns NULL to the calling program.
6 * @rep:scope public
7 * @rep:product PA
8 * @rep:lifecycle active
9 * @rep:displayname Archive Custom Tables Extension
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY PA_PROJECT
12 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14
15 /*#
16 * This procedure is used to purge and archive custom tables as a part of the standard purge process.
17 * @param p_purge_batch_id Identifier of the purge batch
18 * @rep:paraminfo {@rep:required}
19 * @param p_project_id Identifier of the project to be purged
20 * @rep:paraminfo {@rep:required}
21 * @param p_purge_release The Oracle Projects version used to run the purge
22 * @rep:paraminfo {@rep:required}
23 * @param p_txn_through_date For open projects, the date through which the transactions are to be purged
24 * @rep:paraminfo {@rep:required}
25 * @param p_archive_flag Flag indicating whether records in the custom tables are to be archived
26 * @rep:paraminfo {@rep:required}
27 * @param p_calling_place Calling place of the extension. BEFORE_PURGE or AFTER_PURGE indicates
28 * when the system calls the extension.
29 * @rep:paraminfo {@rep:required}
30 * @param p_commit_size Number of archive and purge records to be processed before commitment
31 * @rep:paraminfo {@rep:required}
32 * @param x_err_stack The stack containing all the errors
33 * @rep:paraminfo {@rep:required}
34 * @param x_err_stage The point of occurrence of an error
35 * @rep:paraminfo {@rep:required}
36 * @param x_err_code Error handling code
37 * @rep:paraminfo {@rep:required}
38 * @rep:scope public
39 * @rep:lifecycle active
40 * @rep:displayname Purge Custom Tables
41 * @rep:compatibility S
42 */
43 procedure pa_purge_client_extn ( p_purge_batch_id in NUMBER,
44 p_project_id in NUMBER,
45 p_purge_release in VARCHAR2,
46 p_txn_through_date in DATE,
47 p_archive_flag in VARCHAR2,
48 p_calling_place in VARCHAR2,
49 p_commit_size in NUMBER,
50 x_err_stack in OUT NOCOPY VARCHAR2, --File.Sql.39 bug 4440895
51 x_err_stage in OUT NOCOPY VARCHAR2, --File.Sql.39 bug 4440895
52 x_err_code in OUT NOCOPY NUMBER ) ; --File.Sql.39 bug 4440895
53
54 -- procedure <CUST_PROCEDURE> ( p_purge_batch_id IN NUMBER,
55 -- p_project_id IN NUMBER,
56 -- p_txn_to_date IN DATE,
57 -- p_purge_release IN VARCHAR2,
58 -- p_archive_flag IN VARCHAR2,
59 -- p_commit_size IN NUMBER,
60 -- x_err_code IN OUT NUMBER,
61 -- x_err_stack IN OUT VARCHAR2,
62 -- x_err_stage IN OUT VARCHAR2
63 -- ) ;
64 --
65
66 end pa_purge_extn ;
[Home] [Help]