1 PACKAGE FA_RETIREMENT_PUB as
2 /* $Header: FAPRETS.pls 120.2 2004/12/01 14:07:01 vmarella noship $ */
3 /*#
4 * Creates asset retirements, reinstatements, cancellation of retirements, and
5 * cancellation of reinstatements.
6 * @rep:scope public
7 * @rep:product FA
8 * @rep:lifecycle active
9 * @rep:displayname Retirement/Reinstatement API
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY FA_ASSET
12 * @rep:metalink 206476.1 Retirements/Reinstatements API Documentation Supplement
13 */
14
15
16 /*#
17 * Partially or fully retire an asset in a specific book.
18 * @param p_api_version The version of the API
19 * @param p_init_msg_list The initialize message list flag
20 * @param p_commit The Commit flag
21 * @param p_validation_level The validation level
22 * @param p_calling_fn The calling function
23 * @param x_return_status The return status
24 * @param x_msg_count The message count
25 * @param x_msg_data The message data
26 * @param px_trans_rec The transaction record
27 * @param px_dist_trans_rec The distribution transaction record
28 * @param px_asset_hdr_rec The asset header record
29 * @param px_asset_retire_rec asset retirement record
30 * @param p_asset_dist_tbl table of asset assignments
31 * @param p_subcomp_tbl table of subcomponents
32 * @param p_inv_tbl table of invoices
33 * @rep:scope public
34 * @rep:lifecycle active
35 * @rep:displayname Retire Asset
36 * @rep:compatibility S
37 */
38 PROCEDURE do_retirement
39 (p_api_version in NUMBER
40 ,p_init_msg_list in VARCHAR2 := FND_API.G_FALSE
41 ,p_commit in VARCHAR2 := FND_API.G_FALSE
42 ,p_validation_level in NUMBER := FND_API.G_VALID_LEVEL_FULL
43 ,p_calling_fn in VARCHAR2
44 ,x_return_status out NOCOPY VARCHAR2
45 ,x_msg_count out NOCOPY NUMBER
46 ,x_msg_data out NOCOPY VARCHAR2
47
48 ,px_trans_rec in out NOCOPY FA_API_TYPES.trans_rec_type
49 ,px_dist_trans_rec in out NOCOPY FA_API_TYPES.trans_rec_type
50 ,px_asset_hdr_rec in out NOCOPY FA_API_TYPES.asset_hdr_rec_type
51 ,px_asset_retire_rec in out NOCOPY FA_API_TYPES.asset_retire_rec_type
52 ,p_asset_dist_tbl in FA_API_TYPES.asset_dist_tbl_type
53 ,p_subcomp_tbl in FA_API_TYPES.subcomp_tbl_type
54 ,p_inv_tbl in FA_API_TYPES.inv_tbl_type
55 );
56
57
58 /*#
59 * Undo a retirement previously entered against an asset.
60 * @param p_api_version The version of the API
61 * @param p_init_msg_list The initialize message list flag
62 * @param p_commit The Commit flag
63 * @param p_validation_level The validation level
64 * @param p_calling_fn The calling function
65 * @param x_return_status The return status
66 * @param x_msg_count The message count
67 * @param x_msg_data The message data
68 * @param px_trans_rec The transaction record
69 * @param px_asset_hdr_rec The asset header record
70 * @param px_asset_retire_rec The asset retirement record
71 * @rep:scope public
72 * @rep:lifecycle active
73 * @rep:displayname Cancel Asset Retirement
74 * @rep:compatibility S
75 */
76 PROCEDURE undo_retirement
77 (p_api_version in NUMBER
78 ,p_init_msg_list in VARCHAR2 := FND_API.G_FALSE
79 ,p_commit in VARCHAR2 := FND_API.G_FALSE
80 ,p_validation_level in NUMBER := FND_API.G_VALID_LEVEL_FULL
81 ,p_calling_fn in VARCHAR2
82 ,x_return_status out NOCOPY VARCHAR2
83 ,x_msg_count out NOCOPY NUMBER
84 ,x_msg_data out NOCOPY VARCHAR2
85
86 ,px_trans_rec in out NOCOPY FA_API_TYPES.trans_rec_type
87 ,px_asset_hdr_rec in out NOCOPY FA_API_TYPES.asset_hdr_rec_type
88 ,px_asset_retire_rec in out NOCOPY FA_API_TYPES.asset_retire_rec_type
89 );
90
91
92
93 /*#
94 * Reinstate a retirement previously entered against an asset.
95 * @param p_api_version The version of the API
96 * @param p_init_msg_list The initialize message list flag
97 * @param p_commit The Commit flag
98 * @param p_validation_level The validation level
99 * @param p_calling_fn The calling function
100 * @param x_return_status The return status
101 * @param x_msg_count The message count
102 * @param x_msg_data The message data
103 * @param px_trans_rec The transaction record
104 * @param px_asset_hdr_rec The asset header record
105 * @param px_asset_retire_rec The asset retirement record
106 * @param p_asset_dist_tbl The table of asset assignments
107 * @param p_subcomp_tbl The table of subcomponents
108 * @param p_inv_tbl The table of invoices
109 * @rep:scope public
110 * @rep:lifecycle active
111 * @rep:displayname Reinstate Asset
112 * @rep:compatibility S
113 */
114 PROCEDURE do_reinstatement
115 (p_api_version in NUMBER
116 ,p_init_msg_list in VARCHAR2 := FND_API.G_FALSE
117 ,p_commit in VARCHAR2 := FND_API.G_FALSE
118 ,p_validation_level in NUMBER := FND_API.G_VALID_LEVEL_FULL
119 ,p_calling_fn in VARCHAR2
120 ,x_return_status out NOCOPY VARCHAR2
121 ,x_msg_count out NOCOPY NUMBER
122 ,x_msg_data out NOCOPY VARCHAR2
123
124 ,px_trans_rec in out NOCOPY FA_API_TYPES.trans_rec_type
125 ,px_asset_hdr_rec in out NOCOPY FA_API_TYPES.asset_hdr_rec_type
126 ,px_asset_retire_rec in out NOCOPY FA_API_TYPES.asset_retire_rec_type
127 ,p_asset_dist_tbl in FA_API_TYPES.asset_dist_tbl_type
128 ,p_subcomp_tbl in FA_API_TYPES.subcomp_tbl_type
129 ,p_inv_tbl in FA_API_TYPES.inv_tbl_type
130 );
131
132
133
134 /*#
135 * Undo the reinstatement of a retirement previously entered against an asset.
136 * @param p_api_version The version of the API
137 * @param p_init_msg_list The initialize message list flag
138 * @param p_commit The Commit flag
139 * @param p_validation_level The validation level
140 * @param p_calling_fn The calling function
141 * @param x_return_status The return status
142 * @param x_msg_count The message count
143 * @param x_msg_data The message data
144 * @param px_trans_rec The transaction record
145 * @param px_asset_hdr_rec The asset header record
146 * @param px_asset_retire_rec The asset retirement record
147 * @rep:scope public
148 * @rep:lifecycle active
149 * @rep:displayname Cancel Asset Reinstatement
150 * @rep:compatibility S
151 */
152 PROCEDURE undo_reinstatement
153 (p_api_version in NUMBER
154 ,p_init_msg_list in VARCHAR2 := FND_API.G_FALSE
155 ,p_commit in VARCHAR2 := FND_API.G_FALSE
156 ,p_validation_level in NUMBER := FND_API.G_VALID_LEVEL_FULL
157 ,p_calling_fn in VARCHAR2
158 ,x_return_status out NOCOPY VARCHAR2
159 ,x_msg_count out NOCOPY NUMBER
160 ,x_msg_data out NOCOPY VARCHAR2
161
162 ,px_trans_rec in out NOCOPY FA_API_TYPES.trans_rec_type
163 ,px_asset_hdr_rec in out NOCOPY FA_API_TYPES.asset_hdr_rec_type
164 ,px_asset_retire_rec in out NOCOPY FA_API_TYPES.asset_retire_rec_type
165 );
166
167
168 END FA_RETIREMENT_PUB;