1 PACKAGE OKL_POOL_PUB AUTHID CURRENT_USER AS
2 /* $Header: OKLPSZPS.pls 120.1 2008/02/29 10:16:08 veramach noship $ */
3 /*#
4 * Pool API allows user to create pool, update pool, add and clean contents
5 * from the pool .
6 * @rep:scope public
7 * @rep:product OKL
8 * @rep:displayname Pool
9 * @rep:category BUSINESS_ENTITY OKL_VENDOR_RELATIONSHIP
10 * @rep:lifecycle active
11 * @rep:compatibility S
12 */
13
14 ---------------------------------------------------------------------------
15 -- GLOBAL MESSAGE CONSTANTS
16 ---------------------------------------------------------------------------
17 G_PKG_NAME CONSTANT VARCHAR2(200) := 'OKL_POOL_PUB';
18 G_APP_NAME CONSTANT VARCHAR2(3) := OKL_API.G_APP_NAME;
19
20 SUBTYPE polv_rec_type IS OKL_POOL_PVT.polv_rec_type;
21 SUBTYPE poc_uv_tbl_type IS OKL_POOL_PVT.poc_uv_tbl_type;
22
23
24 ------------------------------------------------------------------------------
25 -- Program Units
26 ------------------------------------------------------------------------------
27 /*#
28 *Create Pool API allows users to create pool.
29 * @param p_api_version API version
30 * @param p_init_msg_list Initialize message stack
31 * @param x_return_status Return status from the API
32 * @param x_msg_count Message count if error messages are encountered
33 * @param x_msg_data Error message data
34 * @param p_polv_rec Pool Record
35 * @param x_polv_rec Pool Record
36 * @rep:displayname Create Pool
37 * @rep:scope public
38 * @rep:lifecycle active
39 * @rep:category BUSINESS_ENTITY OKL_VENDOR_RELATIONSHIP
40 */
41
42
43 PROCEDURE create_pool(
44 p_api_version IN NUMBER
45 ,p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE
46 ,x_return_status OUT NOCOPY VARCHAR2
47 ,x_msg_count OUT NOCOPY NUMBER
48 ,x_msg_data OUT NOCOPY VARCHAR2
49 ,p_polv_rec IN polv_rec_type
50 ,x_polv_rec OUT NOCOPY polv_rec_type
51 );
52
53
54 /*#
55 *Update Pool API allows users to update the pool.
56 * @param p_api_version API version
57 * @param p_init_msg_list Initialize message stack
58 * @param x_return_status Return status from the API
59 * @param x_msg_count Message count if error messages are encountered
60 * @param x_msg_data Error message data
61 * @param p_polv_rec Pool Record
62 * @param x_polv_rec Pool Record
63 * @rep:displayname Update Pool
64 * @rep:scope public
65 * @rep:lifecycle active
66 * @rep:category BUSINESS_ENTITY OKL_VENDOR_RELATIONSHIP
67 */
68
69 /*
70 The description, short description and display in lease center fields of
71 the pool are allowed to be updated in update_pool api.
72 */
73 PROCEDURE update_pool(
74 p_api_version IN NUMBER
75 ,p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE
76 ,x_return_status OUT NOCOPY VARCHAR2
77 ,x_msg_count OUT NOCOPY NUMBER
78 ,x_msg_data OUT NOCOPY VARCHAR2
79 ,p_polv_rec IN polv_rec_type
80 ,x_polv_rec OUT NOCOPY polv_rec_type
81 );
82
83
84 /*#
85 *Clean Up Pool Contents API allows users to clean up the given pool.
86 * @param p_api_version API version
87 * @param p_init_msg_list Initialize message stack
88 * @param x_return_status Return status from the API
89 * @param x_msg_count Message count if error messages are encountered
90 * @param x_msg_data Error message data
91 * @param p_pol_id Pool id
92 * @param p_currency_code Currency Code
93 * @param p_cust_object1_id1 Customer account identifier
94 * @param p_sic_code Service industry code
95 * @param p_khr_id Contract Id
96 * @param p_pre_tax_yield_from Pre Tax Yield From
97 * @param p_pre_tax_yield_to Pre Tax Yield To
98 * @param p_book_classification Book Classification
99 * @param p_tax_owner Tax Owner
100 * @param p_pdt_id Product Id
101 * @param p_start_from_date Start From Date
102 * @param p_start_to_date Start To Date
103 * @param p_end_from_date End From Date
104 * @param p_end_to_date End To Date
105 * @param p_stream_type_subclass Stream Type Subclass
106 * @param p_streams_from_date Streams From Date
107 * @param p_streams_to_date Streams To Date
108 * @param x_poc_uv_tbl Pool Contents table
109 * @rep:displayname Clean Up Pool Contents
110 * @rep:scope public
111 * @rep:lifecycle active
112 * @rep:category BUSINESS_ENTITY OKL_VENDOR_RELATIONSHIP
113 */
114 PROCEDURE cleanup_pool_contents(
115 p_api_version IN NUMBER
116 ,p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE
117 ,x_return_status OUT NOCOPY VARCHAR2
118 ,x_msg_count OUT NOCOPY NUMBER
119 ,x_msg_data OUT NOCOPY VARCHAR2
120 ,p_pol_id IN NUMBER
121 ,p_currency_code IN VARCHAR2
122 ,p_cust_object1_id1 IN NUMBER DEFAULT NULL
123 ,p_sic_code IN VARCHAR2 DEFAULT NULL
124 ,p_khr_id IN NUMBER DEFAULT NULL
125 ,p_pre_tax_yield_from IN NUMBER DEFAULT NULL
126 ,p_pre_tax_yield_to IN NUMBER DEFAULT NULL
127 ,p_book_classification IN VARCHAR2 DEFAULT NULL
128 ,p_tax_owner IN VARCHAR2 DEFAULT NULL
129 ,p_pdt_id IN NUMBER DEFAULT NULL
130 ,p_start_from_date IN DATE DEFAULT NULL
131 ,p_start_to_date IN DATE DEFAULT NULL
132 ,p_end_from_date IN DATE DEFAULT NULL
133 ,p_end_to_date IN DATE DEFAULT NULL
134 ,p_stream_type_subclass IN VARCHAR2 DEFAULT NULL
135 ,p_streams_from_date IN DATE DEFAULT NULL
136 ,p_streams_to_date IN DATE DEFAULT NULL
137 ,x_poc_uv_tbl OUT NOCOPY poc_uv_tbl_type);
138
139
140 /*#
141 *Add Pool Contents API allows users to add pool contents.
142 * @param p_api_version API version
143 * @param p_init_msg_list Initialize message stack
144 * @param x_return_status Return status from the API
145 * @param x_msg_count Message count if error messages are encountered
146 * @param x_msg_data Error message data
147 * @param x_row_count Count of rows added to the pool
148 * @param p_pol_id Pool id
149 * @param p_currency_code Currency Code
150 * @param p_cust_object1_id1 Customer account identifier
151 * @param p_sic_code Service industry code
152 * @param p_khr_id Contract Id
153 * @param p_pre_tax_yield_from Pre Tax Yield From
154 * @param p_pre_tax_yield_to Pre Tax Yield To
155 * @param p_book_classification Book Classification
156 * @param p_tax_owner Tax Owner
157 * @param p_pdt_id Product Id
158 * @param p_start_from_date Start From date
159 * @param p_start_to_date Start To Date
160 * @param p_end_from_date End From Date
161 * @param p_end_to_date End To date
162 * @param p_stream_type_subclass Stream Type Sublass
163 * @param p_stream_element_from_date Stream Element From Date
164 * @param p_stream_element_to_date Stream Element To Date
165 * @param p_log_message flag to log the message Default is Yes
166 * @rep:displayname Add Pool Contents
167 * @rep:scope public
168 * @rep:lifecycle active
169 * @rep:category BUSINESS_ENTITY OKL_VENDOR_RELATIONSHIP
170 */
171 PROCEDURE add_pool_contents(
172 p_api_version IN NUMBER
173 ,p_init_msg_list IN VARCHAR2
174 ,x_return_status OUT NOCOPY VARCHAR2
175 ,x_msg_count OUT NOCOPY NUMBER
176 ,x_msg_data OUT NOCOPY VARCHAR2
177 ,x_row_count OUT NOCOPY NUMBER
178 ,p_pol_id IN NUMBER
179 ,p_currency_code IN VARCHAR2
180 ,p_cust_object1_id1 IN NUMBER
181 ,p_sic_code IN VARCHAR2
182 ,p_khr_id IN NUMBER
183 ,p_pre_tax_yield_from IN NUMBER
184 ,p_pre_tax_yield_to IN NUMBER
185 ,p_book_classification IN VARCHAR2
186 ,p_tax_owner IN VARCHAR2
187 ,p_pdt_id IN NUMBER
188 ,p_start_from_date IN DATE
189 ,p_start_to_date IN DATE
190 ,p_end_from_date IN DATE
191 ,p_end_to_date IN DATE
192 ,p_stream_type_subclass IN VARCHAR2
193 ,p_stream_element_from_date IN DATE
194 ,p_stream_element_to_date IN DATE
195 ,p_log_message IN VARCHAR2 DEFAULT 'Y'
196 );
197
198 END Okl_Pool_PUB;
[Home] [Help]