1 PACKAGE okl_fe_eo_term_options_pub AS
2 /* $Header: OKLPEOTS.pls 120.3 2008/02/29 10:52:16 asawanka ship $ */
3 /*#
4 * End-of-Term Option API allows users to perform actions on
5 * End-of-term Options in Lease Management.
6 * @rep:scope public
7 * @rep:product OKL
8 * @rep:displayname End-of-Term Option API
9 * @rep:category BUSINESS_ENTITY OKL_EOT
10 * @rep:lifecycle active
11 * @rep:compatibility S
12 */
13
14 -- record structure for the End of Term Options Header
15
16 SUBTYPE okl_ethv_rec IS okl_eth_pvt.okl_ethv_rec;
17
18 SUBTYPE okl_ethv_tbl IS okl_eth_pvt.okl_ethv_tbl;
19
20 -- record structure for the End of Term Options Version Details
21
22 SUBTYPE okl_eve_rec IS okl_eve_pvt.okl_eve_rec;
23
24 SUBTYPE okl_eve_tbl IS okl_eve_pvt.okl_eve_tbl;
25
26 -- record structure for the End of Term Object Values
27
28 SUBTYPE okl_etv_rec IS okl_etv_pvt.okl_etv_rec;
29
30 SUBTYPE okl_etv_tbl IS okl_etv_pvt.okl_etv_tbl;
31
32 -- record structure for the End of Term Option Objects
33
34 SUBTYPE okl_eto_rec IS okl_eto_pvt.okl_eto_rec;
35
36 SUBTYPE okl_eto_tbl IS okl_eto_pvt.okl_eto_tbl;
37
38 SUBTYPE invalid_object_tbl IS okl_fe_eo_term_options_pvt.invalid_object_tbl; -- Global variables
39 g_pkg_name CONSTANT VARCHAR2(200) := 'OKL_FE_EO_TERM_OPTIONS_PUB';
40 g_app_name CONSTANT VARCHAR2(3) := okl_api.g_app_name;
41
42 --G_UNEXPECTED_ERROR CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_UNEXPECTED_ERROR';
43
44 g_exc_name_error CONSTANT VARCHAR2(50) := 'OKL_API.G_RET_STS_ERROR';
45 g_exc_name_unexp_error CONSTANT VARCHAR2(50) := 'OKL_API.G_RET_STS_UNEXP_ERROR';
46 g_exc_name_others CONSTANT VARCHAR2(6) := 'OTHERS';
47 g_sqlerrm_token CONSTANT VARCHAR2(200) := 'SQLERRM';
48 g_sqlcode_token CONSTANT VARCHAR2(200) := 'SQLCODE';
49
50 ------------------------------------------------------------------------------
51 --Global Exception
52 ------------------------------------------------------------------------------
53
54 g_exception_halt_validation EXCEPTION;
55
56 PROCEDURE get_item_lines(p_api_version IN NUMBER
57 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
58 ,x_return_status OUT NOCOPY VARCHAR2
59 ,x_msg_count OUT NOCOPY NUMBER
60 ,x_msg_data OUT NOCOPY VARCHAR2
61 ,p_po_id IN NUMBER
62 ,p_po_version IN VARCHAR2
63 ,x_eto_tbl OUT NOCOPY okl_eto_tbl);
64
65 PROCEDURE get_eo_term_values(p_api_version IN NUMBER
66 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
67 ,x_return_status OUT NOCOPY VARCHAR2
68 ,x_msg_count OUT NOCOPY NUMBER
69 ,x_msg_data OUT NOCOPY VARCHAR2
70 ,p_po_id IN NUMBER
71 ,p_po_version IN VARCHAR2
72 ,x_etv_tbl OUT NOCOPY okl_etv_tbl);
73
74 PROCEDURE get_end_of_term_option(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_po_id IN NUMBER
80 ,p_po_version IN VARCHAR2
81 ,x_ethv_rec OUT NOCOPY okl_ethv_rec
82 ,x_eve_rec OUT NOCOPY okl_eve_rec
83 ,x_eto_tbl OUT NOCOPY okl_eto_tbl
84 ,x_etv_tbl OUT NOCOPY okl_etv_tbl);
85
86 /*#
87 * Create End-of-Term Option.
88 * @param p_api_version API version
89 * @param p_init_msg_list Initialize message stack
90 * @param x_return_status Return status from the API
91 * @param x_msg_count Message count if error messages are encountered
92 * @param x_msg_data Error message data
93 * @param p_ethv_rec End-of-Term Option header record
94 * @param p_eve_rec End-of-Term Option Version record
95 * @param p_eto_tbl End-of-Term Option Objects table
96 * @param p_etv_tbl End-of-Term Option Values table
97 * @param x_ethv_rec End-of-Term Option header record
98 * @param x_eve_rec End-of-Term Option Version record
99 * @param x_eto_tbl End-of-Term Option Objects table
100 * @param x_etv_tbl End-of-Term Option Values table
101 * @rep:displayname Create End-of-Term Option
102 * @rep:scope public
103 * @rep:lifecycle active
104 * @rep:category BUSINESS_ENTITY OKL_MARKETING_PROGRAM
105 */
106 PROCEDURE insert_end_of_term_option(p_api_version IN NUMBER
107 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
108 ,x_return_status OUT NOCOPY VARCHAR2
109 ,x_msg_count OUT NOCOPY NUMBER
110 ,x_msg_data OUT NOCOPY VARCHAR2
111 ,p_ethv_rec IN okl_ethv_rec
112 ,p_eve_rec IN okl_eve_rec
113 ,p_eto_tbl IN okl_eto_tbl
114 ,p_etv_tbl IN okl_etv_tbl
115 ,x_ethv_rec OUT NOCOPY okl_ethv_rec
116 ,x_eve_rec OUT NOCOPY okl_eve_rec
117 ,x_eto_tbl OUT NOCOPY okl_eto_tbl
118 ,x_etv_tbl OUT NOCOPY okl_etv_tbl);
119
120 PROCEDURE update_end_of_term_option(p_api_version IN NUMBER
121 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
122 ,x_return_status OUT NOCOPY VARCHAR2
123 ,x_msg_count OUT NOCOPY NUMBER
124 ,x_msg_data OUT NOCOPY VARCHAR2
125 ,p_eve_rec IN okl_eve_rec
126 ,p_eto_tbl IN okl_eto_tbl
127 ,p_etv_tbl IN okl_etv_tbl
128 ,x_eve_rec OUT NOCOPY okl_eve_rec
129 ,x_eto_tbl OUT NOCOPY okl_eto_tbl
130 ,x_etv_tbl OUT NOCOPY okl_etv_tbl);
131
132 PROCEDURE create_version(p_api_version IN NUMBER
133 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
134 ,x_return_status OUT NOCOPY VARCHAR2
135 ,x_msg_count OUT NOCOPY NUMBER
136 ,x_msg_data OUT NOCOPY VARCHAR2
137 ,p_eve_rec IN okl_eve_rec
138 ,p_eto_tbl IN okl_eto_tbl
139 ,p_etv_tbl IN okl_etv_tbl
140 ,x_eve_rec OUT NOCOPY okl_eve_rec
141 ,x_eto_tbl OUT NOCOPY okl_eto_tbl
142 ,x_etv_tbl OUT NOCOPY okl_etv_tbl);
143
144 PROCEDURE validate_end_of_term_option(p_api_version IN NUMBER
145 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
146 ,x_return_status OUT NOCOPY VARCHAR2
147 ,x_msg_count OUT NOCOPY NUMBER
148 ,x_msg_data OUT NOCOPY VARCHAR2
149 ,p_end_of_ver_id IN NUMBER);
150
151 PROCEDURE handle_approval(p_api_version IN NUMBER
152 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
153 ,x_return_status OUT NOCOPY VARCHAR2
154 ,x_msg_count OUT NOCOPY NUMBER
155 ,x_msg_data OUT NOCOPY VARCHAR2
156 ,p_end_of_term_ver_id IN NUMBER);
157
158 -- to find the list of all the invalid object refernces
159
160 PROCEDURE invalid_objects(p_api_version IN NUMBER
161 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
162 ,x_return_status OUT NOCOPY VARCHAR2
163 ,x_msg_count OUT NOCOPY NUMBER
164 ,x_msg_data OUT NOCOPY VARCHAR2
165 ,p_version_id IN NUMBER
166 ,x_obj_tbl OUT NOCOPY invalid_object_tbl);
167
168 -- to calculate the start date of the new version
169
170 PROCEDURE calc_start_date(p_api_version IN NUMBER
171 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
172 ,x_return_status OUT NOCOPY VARCHAR2
173 ,x_msg_count OUT NOCOPY NUMBER
174 ,x_msg_data OUT NOCOPY VARCHAR2
175 ,p_eve_rec IN okl_eve_rec
176 ,x_cal_eff_from OUT NOCOPY DATE);
177
178 PROCEDURE submit_end_of_term(p_api_version IN NUMBER
179 ,p_init_msg_list IN VARCHAR2 DEFAULT okl_api.g_false
180 ,x_return_status OUT NOCOPY VARCHAR2
181 ,x_msg_count OUT NOCOPY NUMBER
182 ,x_msg_data OUT NOCOPY VARCHAR2
183 ,p_end_of_term_ver_id IN NUMBER);
184
185 END okl_fe_eo_term_options_pub;
[Home] [Help]