1 PACKAGE PN_LEASE_PUB AUTHID CURRENT_USER AS
2 /* $Header: PNLSPUBS.pls 120.5.12020000.2 2012/07/18 09:59:22 admarath ship $ */
3 /*#
4 * This package contains the public APIs for lease and terms information.
5 * @rep:scope public
6 * @rep:product PN
7 * @rep:lifecycle active
8 * @rep:displayname Lease Definition
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PN_LEASE
11 */
12 /*********************************************/
13 -- Procedure to create a new lease
14 /*********************************************/
15 /*#
16 * This API creates a new lease in the Oracle Projects.
17 * @param p_api_version API standard version number
18 * @rep:paraminfo {@rep:required}
19 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
20 * @param p_commit API standard (default = F): indicates if transaction will be committed
21 * @param p_validate Indicates whether the system performs scheduling validations. Default is Y
22 * @rep:paraminfo {@rep:precision 1}
23 * @param p_lease_rec Input Output Lease details
24 * @rep:paraminfo {@rep:required}
25 * @param p_lease_exp_rev_accounts_rec Input Output Lease Expense and Revenue Account details
26 * @rep:paraminfo {@rep:required}
27 * @param p_lease_accrual_account_rec Input Output Lease Accrual Account details
28 * @rep:paraminfo {@rep:required}
29 * @param p_lease_liab_rcvl_account_rec Input Output Lease Liable or Receivable Account details
30 * @rep:paraminfo {@rep:required}
31 * @param p_contacts_tbl Input Output identifier for Lease Contacts table
32 * @param p_tenancies_tbl Input Output identifier for Lease Tenancies table
33 * @param p_insurance_tbl Input Output identifier for Lease Insurance table
34 * @param p_right_tbl Input Output identifier for Lease Right table
35 * @param p_obligation_tbl Input Output identifier for Lease Obligation table
36 * @param p_option_tbl Input Output identifier for Lease Option table
37 * @param p_lease_payment_term_tbl Input Output identifier for Lease Payment Term table
38 * @rep:paraminfo {@rep:required}
39 * @param p_note_tbl Input Output identifier for Lease note table
40 * @param x_msg_count API standard: number of error messages
41 * @rep:paraminfo {@rep:required}
42 * @param x_msg_data API standard: error message
43 * @rep:paraminfo {@rep:precision 2000} {@rep:required}
44 * @param x_return_status API standard: return of the API (success/failure/unexpected error)
45 * @rep:paraminfo {@rep:precision 1} {@rep:required}
46 * @param p_lease_context identifier for lease context
47 * @rep:paraminfo {@rep:precision 30} {@rep:required}
48 * @rep:scope public
49 * @rep:lifecycle active
50 * @rep:displayname Create Lease
51 * @rep:compatibility S
52 * @rep:category BUSINESS_ENTITY PN_LEASE
53 */
54 PROCEDURE create_lease (
55 p_api_version IN NUMBER
56 , p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
57 , p_commit IN VARCHAR2 := fnd_api.g_false
58 , p_validate IN VARCHAR2 := fnd_api.g_false
59 , p_lease_rec IN OUT NOCOPY PN_LEASE_PVT.lease_rec
60 , p_lease_exp_rev_accounts_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
61 , p_lease_accrual_account_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
62 , p_lease_liab_rcvl_account_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
63 , p_contacts_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_contacts_tbl
64 , p_tenancies_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_tenancies_tbl
65 , p_insurance_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_insurance_tbl_type
66 , p_right_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_right_tbl_type
67 , p_obligation_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_obligation_tbl_type
68 , p_option_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_option_tbl_type
69 , p_lease_payment_term_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_terms_tbl
70 , p_note_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_note_tbl_type
71 , x_msg_count OUT NOCOPY NUMBER
72 , x_msg_data OUT NOCOPY VARCHAR2
73 , x_return_status OUT NOCOPY VARCHAR2
74 , p_lease_context IN VARCHAR2
75 );
76 /*********************************************/
77 -- Procedure to update lease
78 /*********************************************/
79 /*#
80 * This API updates a lease in the Oracle Projects.
81 * @param p_api_version API standard version number
82 * @rep:paraminfo {@rep:required}
83 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
84 * @param p_commit API standard (default = F): indicates if transaction will be committed
85 * @param p_validate Indicates whether the system performs scheduling validations. Default is Y
86 * @rep:paraminfo {@rep:precision 1}
87 * @param p_lease_rec Input Output Lease details
88 * @rep:paraminfo {@rep:required}
89 * @param p_lease_exp_rev_accounts_rec Input Output Lease Expense and Revenue Account details
90 * @rep:paraminfo {@rep:required}
91 * @param p_lease_accrual_account_rec Input Output Lease Accrual Account details
92 * @rep:paraminfo {@rep:required}
93 * @param p_lease_liab_rcvl_account_rec Input Output Lease Liable or Receivable Account details
94 * @rep:paraminfo {@rep:required}
95 * @param p_lease_contacts_tbl Input Output identifier for Lease Contacts table type
96 * @param p_lease_tenancies_tbl Input Output identifier for Lease Tenancies table type
97 * @param p_lease_context identifier for lease context
98 * @rep:paraminfo {@rep:precision 30} {@rep:required}
99 * @param p_right_tbl Input Output identifier for Lease Rights table type
100 * @param p_note_tbl Input Output identifier for Lease notes table type
101 * @param p_obligation_tbl Input Output identifier for Lease Obligations table type
102 * @param p_insurance_tbl Input Output identifier for Lease Insurance table type
103 * @param p_option_tbl Input Output identifier for Lease Option table type
104 * @param p_lease_payment_term_tbl Input Output identifier for Lease Payment Term table type
105 * @rep:paraminfo {@rep:required}
106 * @param x_return_status API standard: return of the API (success/failure/unexpected error)
107 * @rep:paraminfo {@rep:precision 1} {@rep:required}
108 * @param x_msg_count API standard: number of error messages
109 * @rep:paraminfo {@rep:required}
110 * @param x_msg_data API standard: error message
111 * @rep:paraminfo {@rep:precision 2000} {@rep:required}
112 * @rep:scope public
113 * @rep:lifecycle active
114 * @rep:displayname Update Lease
115 * @rep:category BUSINESS_ENTITY PN_LEASE
116 * @rep:compatibility S
117 */
118 PROCEDURE update_lease (
119 p_api_version IN NUMBER
120 , p_init_msg_list IN VARCHAR2 := fnd_api.g_false
121 , p_commit IN VARCHAR2 := fnd_api.g_false
122 , p_validate IN VARCHAR2 := fnd_api.g_false
123 , p_lease_rec IN OUT NOCOPY PN_LEASE_PVT.lease_rec
124 , p_lease_exp_rev_accounts_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
125 , p_lease_accrual_account_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
126 , p_lease_liab_rcvl_account_rec IN OUT NOCOPY PN_LEASE_PVT.lease_account_rec
127 , p_lease_contacts_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_contacts_tbl
128 , p_lease_tenancies_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_tenancies_tbl
129 , p_lease_context IN VARCHAR2 DEFAULT 'UPD'
130 , p_right_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_right_tbl_type
131 , p_note_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_note_tbl_type
132 , p_obligation_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_obligation_tbl_type
133 , p_insurance_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_insurance_tbl_type
134 , p_option_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_option_tbl_type
135 , p_lease_payment_term_tbl IN OUT NOCOPY PN_LEASE_PVT.lease_terms_tbl
136 -- , x_lease_id OUT NOCOPY NUMBER
137 -- , x_lease_number OUT NOCOPY VARCHAR2
138 -- , x_lease_name OUT NOCOPY VARCHAR2
139 , x_return_status OUT NOCOPY VARCHAR2
140 , x_msg_count OUT NOCOPY NUMBER
141 , x_msg_data OUT NOCOPY VARCHAR2
142 );
143
144 /*********************************************/
145 --Procedure to Create Payment Terms
146 /*********************************************/
147 /*#
148 * This API creates new payment terms for the lease in the Oracle Projects.
149 * @param p_api_version API standard version number
150 * @rep:paraminfo {@rep:required}
151 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
152 * @param p_commit API standard (default = F): indicates if transaction will be committed
153 * @param p_validate Indicates whether the system performs scheduling validations. Default is Y
154 * @rep:paraminfo {@rep:precision 1}
155 * @param p_payment_terms_tbl Input Output identifier for payment Terms table type
156 * @rep:paraminfo {@rep:required}
157 * @param p_lease_id Input number identifier for Lease id
158 * @rep:paraminfo {@rep:required}
159 * @param p_lease_context identifier for lease context
160 * @rep:paraminfo {@rep:precision 30} {@rep:required}
161 * @param x_return_status API standard: return of the API (success/failure/unexpected error)
162 * @rep:paraminfo {@rep:precision 1} {@rep:required}
163 * @param x_msg_count API standard: number of error messages
164 * @rep:paraminfo {@rep:required}
165 * @param x_msg_data API standard: error message
166 * @rep:paraminfo {@rep:precision 2000} {@rep:required}
167 * @rep:scope public
168 * @rep:lifecycle active
169 * @rep:displayname Create Term
170 * @rep:category BUSINESS_ENTITY PN_LEASE
171 * @rep:compatibility S
172 */
173 PROCEDURE create_terms (
174 p_api_version IN NUMBER
175 , p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
176 , p_commit IN VARCHAR2 := FND_API.G_FALSE
177 , p_validate IN VARCHAR2 := FND_API.G_FALSE
178 , p_payment_terms_tbl IN OUT NOCOPY pn_lease_pvt.lease_terms_tbl
179 , p_lease_id IN NUMBER
180 , p_lease_context IN VARCHAR2 DEFAULT NULL
181 , x_return_status OUT NOCOPY VARCHAR2
182 , x_msg_count OUT NOCOPY NUMBER
183 , x_msg_data OUT NOCOPY VARCHAR2
184 );
185
186 /*********************************************/
187 -- Procedure to update a payment terms
188 /*********************************************/
189 /*#
190 * This API updates payment terms for the lease in the Oracle Projects.
191 * @param p_api_version API standard version number
192 * @rep:paraminfo {@rep:required}
193 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
194 * @param p_commit API standard (default = F): indicates if transaction will be committed
195 * @param p_validate Indicates whether the system performs scheduling validations. Default is Y
196 * @rep:paraminfo {@rep:precision 1}
197 * @param p_payment_terms_tbl Input Output identifier for payment Terms table type
198 * @rep:paraminfo {@rep:required}
199 * @param p_lease_id Input number identifier for Lease id
200 * @rep:paraminfo {@rep:required}
201 * @param p_lease_context identifier for lease context
202 * @rep:paraminfo {@rep:precision 30} {@rep:required}
203 * @param x_return_status API standard: return of the API (success/failure/unexpected error)
204 * @rep:paraminfo {@rep:precision 1} {@rep:required}
205 * @param x_msg_count API standard: number of error messages
206 * @rep:paraminfo {@rep:required}
207 * @param x_msg_data API standard: error message
208 * @rep:paraminfo {@rep:precision 2000} {@rep:required}
209 * @rep:scope public
210 * @rep:lifecycle active
211 * @rep:displayname Update Term
212 * @rep:category BUSINESS_ENTITY PN_LEASE
213 * @rep:compatibility S
214 */
215 PROCEDURE update_terms (
216 p_api_version IN NUMBER
217 , p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
218 , p_commit IN VARCHAR2 := FND_API.G_FALSE
219 , p_validate IN VARCHAR2 := FND_API.G_FALSE
220 , p_payment_terms_tbl IN OUT NOCOPY pn_lease_pvt.lease_terms_tbl
221 , p_lease_id IN NUMBER
222 , p_lease_context IN VARCHAR2 DEFAULT NULL
223 , x_return_status OUT NOCOPY VARCHAR2
224 , x_msg_count OUT NOCOPY NUMBER
225 , x_msg_data OUT NOCOPY VARCHAR2
226 );
227
228 /*********************************************/
229 -- Procedure to update a lease status
230 /*********************************************/
231 /*#
232 * This API updates a lease status for the lease in the Oracle Projects.
233 * @param p_api_version API standard version number
234 * @rep:paraminfo {@rep:required}
235 * @param p_init_msg_list API standard (default = F): indicates if message stack will be initialized
236 * @param p_commit API standard (default = F): indicates if transaction will be committed
237 * @param p_lease_id Input number identifier for Lease id
238 * @rep:paraminfo {@rep:required}
239 * @param p_new_approval_status_code input Output identifier for new approval status code
240 * @rep:paraminfo {@rep:required}
241 * @param p_new_lease_status input Output identifier for new lease status
242 * @rep:paraminfo {@rep:required}
243 * @param p_operation input identifier for lease operation.(default = 'UPDATE_STATUS')
244 * @param x_return_status API standard: return of the API (success/failure/unexpected error)
245 * @rep:paraminfo {@rep:precision 1} {@rep:required}
246 * @param x_msg_count API standard: number of error messages
247 * @rep:paraminfo {@rep:required}
248 * @param x_msg_data API standard: error message
249 * @rep:paraminfo {@rep:precision 2000} {@rep:required}
250 * @rep:scope public
251 * @rep:lifecycle active
252 * @rep:displayname Update Status
253 * @rep:category BUSINESS_ENTITY PN_LEASE
254 * @rep:compatibility S
255 */
256 PROCEDURE update_status( p_api_version IN NUMBER
257 , p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false
258 , p_commit IN VARCHAR2 DEFAULT fnd_api.g_false
259 , p_lease_id IN OUT NOCOPY NUMBER
260 , p_new_approval_status_code IN OUT NOCOPY VARCHAR2
261 , p_new_lease_status IN OUT NOCOPY VARCHAR2
262 , p_operation IN VARCHAR2 DEFAULT 'UPDATE_STATUS'
263 , x_return_status OUT NOCOPY VARCHAR2
264 , x_msg_count OUT NOCOPY NUMBER
265 , x_msg_data OUT NOCOPY VARCHAR2
266 );
267 END PN_LEASE_PUB;
[Home] [Help]