1 PACKAGE OKL_XLA_EVENTS_PVT AUTHID CURRENT_USER AS
2 /* $Header: OKLRCSES.pls 120.0 2007/02/22 21:40:14 racheruv noship $ */
3
4 -------------------------------------------------------------------------------
5 -- Event creation routines
6 -------------------------------------------------------------------------------
7 -- Public function to raise an accounting event in SLA and return the event id.
8 FUNCTION create_event(
9 p_api_version IN NUMBER
10 ,p_init_msg_list IN VARCHAR2
11 ,x_return_status OUT NOCOPY VARCHAR2
12 ,x_msg_count OUT NOCOPY NUMBER
13 ,x_msg_data OUT NOCOPY VARCHAR2
14 ,p_tcn_id IN NUMBER
15 ,p_gl_date IN DATE
16 ,p_action_type IN VARCHAR2
17 ,p_representation_code IN VARCHAR2
18 ) RETURN INTEGER;
19
20 -------------------------------------------------------------------------------
21 -- Event updation routines
22 -------------------------------------------------------------------------------
23 -- Public API to update the attributes of an event. Based on the parameters
24 -- passed, API calls an appropriate SLA's update event APIs.
25 PROCEDURE update_event(
26 p_api_version IN NUMBER
27 ,p_init_msg_list IN VARCHAR2
28 ,x_return_status OUT NOCOPY VARCHAR2
29 ,x_msg_count OUT NOCOPY NUMBER
30 ,x_msg_data OUT NOCOPY VARCHAR2
31 ,p_tcn_id IN NUMBER
32 ,p_gl_date IN DATE DEFAULT NULL
33 ,p_action_type IN VARCHAR2 DEFAULT NULL
34 ,p_event_id IN NUMBER
35 ,p_event_type_code IN VARCHAR2
36 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
37 ,p_event_number IN NUMBER DEFAULT NULL
38 ,p_update_ref_info IN VARCHAR2 DEFAULT 'N'
39 ,p_reference_info IN xla_events_pub_pkg.t_event_reference_info DEFAULT NULL
40 ,p_representation_code IN VARCHAR2);
41
42 -- API to update the event date. This is called by Period Sweep Program.
43 -- p_gl_date represents the new event date that is stamped on events.
44 PROCEDURE update_event(
45 p_api_version IN NUMBER
46 ,p_init_msg_list IN VARCHAR2
47 ,x_return_status OUT NOCOPY VARCHAR2
48 ,x_msg_count OUT NOCOPY NUMBER
49 ,x_msg_data OUT NOCOPY VARCHAR2
50 ,p_tcn_id IN NUMBER
51 ,p_event_id IN NUMBER
52 ,p_gl_date IN DATE);
53
54 -- API to update event status of one or more matching events within an entity
55 PROCEDURE update_event_status(
56 p_api_version IN NUMBER
57 ,p_init_msg_list IN VARCHAR2
58 ,x_return_status OUT NOCOPY VARCHAR2
59 ,x_msg_count OUT NOCOPY NUMBER
60 ,x_msg_data OUT NOCOPY VARCHAR2
61 ,p_tcn_id IN NUMBER
62 ,p_gl_date IN DATE
63 ,p_action_type IN VARCHAR2
64 ,p_representation_code IN VARCHAR2
65 ,p_event_status_code IN VARCHAR2);
66
67 TYPE tcn_tbl_type IS TABLE OF okl_trx_contracts_all.id%TYPE INDEX BY BINARY_INTEGER;
68 TYPE try_tbl_type IS TABLE OF okl_trx_contracts_all.try_id%TYPE INDEX BY BINARY_INTEGER;
69 TYPE ledger_tbl_type IS TABLE OF okl_trx_contracts_all.set_of_books_id%TYPE INDEX BY BINARY_INTEGER;
70
71 -- API to update the event status in bulk. If p_action_type is null, then
72 -- events for both create and reverse event types are updated.
73 PROCEDURE update_bulk_event_statuses(
74 p_api_version IN NUMBER
75 ,p_init_msg_list IN VARCHAR2
76 ,x_return_status OUT NOCOPY VARCHAR2
77 ,x_msg_count OUT NOCOPY NUMBER
78 ,x_msg_data OUT NOCOPY VARCHAR2
79 ,p_tcn_tbl IN tcn_tbl_type
80 ,p_try_id IN NUMBER
81 ,p_ledger_id IN NUMBER
82 ,p_action_type IN VARCHAR2 DEFAULT NULL
83 ,p_event_status_code IN VARCHAR2
84 );
85
86 -------------------------------------------------------------------------------
87 -- Event deletion routines
88 -------------------------------------------------------------------------------
89 -- API to delete a single unaccounted event based on event id.
90 PROCEDURE delete_event(
91 p_api_version IN NUMBER
92 ,p_init_msg_list IN VARCHAR2
93 ,x_return_status OUT NOCOPY VARCHAR2
94 ,x_msg_count OUT NOCOPY NUMBER
95 ,x_msg_data OUT NOCOPY VARCHAR2
96 ,p_tcn_id IN NUMBER
97 ,p_event_id IN NUMBER
98 ,p_representation_code IN VARCHAR2);
99
100 -- API to delete all events for a transaction that meet the criteria. This
101 -- API deletes events that belong to the given event class, event type, and
102 -- event date. Returns number of events deleted. Returns -1 if an error occurs.
103 FUNCTION delete_events(
104 p_api_version IN NUMBER
105 ,p_init_msg_list IN VARCHAR2
106 ,x_return_status OUT NOCOPY VARCHAR2
107 ,x_msg_count OUT NOCOPY NUMBER
108 ,x_msg_data OUT NOCOPY VARCHAR2
109 ,p_tcn_id IN NUMBER
110 ,p_action_type IN VARCHAR2
111 ,p_gl_date IN DATE
112 ,p_representation_code IN VARCHAR2)
113 RETURN INTEGER;
114
115 -------------------------------------------------------------------------------
116 -- Event information routines
117 -------------------------------------------------------------------------------
118 -- API to return the information about an event in a record structure.
119 FUNCTION get_event_info(
120 p_api_version IN NUMBER
121 ,p_init_msg_list IN VARCHAR2
122 ,x_return_status OUT NOCOPY VARCHAR2
123 ,x_msg_count OUT NOCOPY NUMBER
124 ,x_msg_data OUT NOCOPY VARCHAR2
125 ,p_tcn_id IN NUMBER
126 ,p_event_id IN NUMBER
127 ,p_representation_code IN VARCHAR2)
128 RETURN xla_events_pub_pkg.t_event_info;
129
130 -- API to return information for one or more events within a transaction for
131 -- a given criteria. An array of records is returned with the event info.
132 -- If action_type is passed, then the events corresponding to that event_type -- will be returned.
133 -- If p_action_type is null, then all events for that event class will be
134 -- returned.
135 -- If gl_date is passed, all events for the transaction matching event date will be
136 -- returned.
137 FUNCTION get_array_event_info(
138 p_api_version IN NUMBER
139 ,p_init_msg_list IN VARCHAR2
140 ,x_return_status OUT NOCOPY VARCHAR2
141 ,x_msg_count OUT NOCOPY NUMBER
142 ,x_msg_data OUT NOCOPY VARCHAR2
143 ,p_tcn_id IN NUMBER
144 ,p_action_type IN VARCHAR2 DEFAULT NULL
145 ,p_gl_date IN DATE DEFAULT NULL
146 ,p_event_status_code IN VARCHAR2 DEFAULT NULL
147 ,p_representation_code IN VARCHAR2)
148 RETURN xla_events_pub_pkg.t_array_event_info;
149
150 -- API to provide the status for a given event.
151 FUNCTION get_event_status(
152 p_api_version IN NUMBER
153 ,p_init_msg_list IN VARCHAR2
154 ,x_return_status OUT NOCOPY VARCHAR2
155 ,x_msg_count OUT NOCOPY NUMBER
156 ,x_msg_data OUT NOCOPY VARCHAR2
157 ,p_tcn_id IN NUMBER
158 ,p_event_id IN NUMBER
159 ,p_representation_code IN VARCHAR2)
160 RETURN VARCHAR2;
161
162 -- API to check if an event has been raised for the transaction.
163 -- If p_action_type is passed, corresponding event for Create or Reverse
164 -- action will be identified, otherwise existence of event for the transaction
165 -- is checked and value returned.
166 PROCEDURE event_exists(p_api_version IN NUMBER
167 ,p_init_msg_list IN VARCHAR2
168 ,x_return_status OUT NOCOPY VARCHAR2
169 ,x_msg_count OUT NOCOPY NUMBER
170 ,x_msg_data OUT NOCOPY VARCHAR2
171 ,p_tcn_id IN NUMBER
172 ,p_action_type IN VARCHAR2
173 ,x_event_id OUT NOCOPY NUMBER
174 ,x_event_date OUT NOCOPY DATE);
175
176 g_application_id CONSTANT NUMBER := 540;
177 g_app_name CONSTANT VARCHAR2(3) := Okl_Api.G_APP_NAME;
178 g_unexpected_error CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_UNEXPECTED_ERROR';
179 g_sqlerrm_token CONSTANT VARCHAR2(200) := 'OKL_SQLerrm';
180 g_sqlcode_token CONSTANT VARCHAR2(200) := 'OKL_SQLcode';
181 g_pkg_name CONSTANT VARCHAR2(30) := 'OKL_XLA_EVENTS';
182
183 END OKL_XLA_EVENTS_PVT;
[Home] [Help]