1 PACKAGE CSI_COUNTER_PUB AUTHID CURRENT_USER AS
2 /* $Header: csipctis.pls 120.3.12010000.1 2008/07/25 08:10:57 appldev ship $ */
3 /*#
4 * This is a public API for managing Counter Instances.
5 * It contains routines to Create and Update Counter Instances.
6 * @rep:scope public
7 * @rep:product CSI
8 * @rep:displayname Manage Counter Instances
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CSI_COUNTER
12 */
13
14 --|---------------------------------------------------
15 --| procedure name: create_counter
16 --| description : procedure used to
17 --| create counter instance
18 --|---------------------------------------------------
19 /*#
20 * This procedure is used to create Counter Instance.
21 * In this procedure, it can also create counter properties, associations, counter relationships, derived filters
22 * @param p_api_version Current API version
23 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
24 * @param p_commit API commits if set to fnd_api.g_true
25 * @param p_validation_level API validation level
26 * @param p_counter_instance_rec Counter Record structure
27 * @param P_ctr_properties_tbl Counter Properties Table
28 * @param P_counter_relationships_tbl Contains the Counter Relationships Table
29 * @param P_ctr_derived_filters_tbl Contains the Counter Derived Filters Table
30 * @param P_counter_associations_tbl Contains the Counter Associations Table
31 * @param x_return_status API Return Status
32 * @param x_msg_count Message count
33 * @param x_msg_data Message Data
34 * @param x_ctr_id Counter Id
35 * @rep:scope public
36 * @rep:lifecycle active
37 * @rep:displayname Create Counter
38 */
39
40 PROCEDURE create_counter
41 (
42 p_api_version IN NUMBER
43 ,p_init_msg_list IN VARCHAR2
44 ,p_commit IN VARCHAR2
45 ,p_validation_level IN NUMBER
46 ,p_counter_instance_rec IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Counter_instance_rec
47 ,P_ctr_properties_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Ctr_properties_tbl
48 ,P_counter_relationships_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_relationships_tbl
49 ,P_ctr_derived_filters_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.ctr_derived_filters_tbl
50 ,P_counter_associations_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_associations_tbl
51 ,x_return_status out NOCOPY VARCHAR2
52 ,x_msg_count out NOCOPY NUMBER
53 ,x_msg_data out NOCOPY VARCHAR2
54 ,x_ctr_id out NOCOPY NUMBER
55 );
56
57 --|---------------------------------------------------
58 --| procedure name: create_ctr_property
59 --| description : procedure used to
60 --| create counter properties
61 --|---------------------------------------------------
62 /*#
63 * This procedure is used to create Counter properties.
64 * @param p_api_version Current API version
65 * @param p_commit API commits if set to fnd_api.g_true
66 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
67 * @param p_validation_level API validation level
68 * @param P_ctr_properties_tbl Counter Properties Table
69 * @param x_return_status API Return Status
70 * @param x_msg_count Message count
71 * @param x_msg_data Message Data
72 * @param x_ctr_property_id Counter Property Id
73 * @rep:scope public
74 * @rep:lifecycle active
75 * @rep:displayname Create Counter Property
76 */
77
78 PROCEDURE create_ctr_property
79 (
80 p_api_version IN NUMBER
81 ,p_commit IN VARCHAR2
82 ,p_init_msg_list IN VARCHAR2
83 ,p_validation_level IN NUMBER
84 ,P_ctr_properties_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Ctr_properties_tbl
85 ,x_return_status OUT NOCOPY VARCHAR2
86 ,x_msg_count OUT NOCOPY NUMBER
87 ,x_msg_data OUT NOCOPY VARCHAR2
88 ,x_ctr_property_id OUT NOCOPY NUMBER
89 );
90
91 --|---------------------------------------------------
92 --| procedure name: create_ctr_associations
93 --| description : procedure used to
94 --| create counter associations
95 --|---------------------------------------------------
96 /*#
97 * This procedure is used to create Counter Association.
98 * @param p_api_version Current API version
99 * @param p_commit API commits if set to fnd_api.g_true
100 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
101 * @param p_validation_level API validation level
102 * @param P_counter_associations_tbl Contains the Counter Associations Table
103 * @param x_return_status API Return Status
104 * @param x_msg_count Message count
105 * @param x_msg_data Message Data
106 * @param x_instance_association_id Instance Association Id
107 * @rep:scope public
108 * @rep:lifecycle active
109 * @rep:displayname Create Counter Association
110 */
111
112 PROCEDURE create_ctr_associations
113 (
114 p_api_version IN NUMBER
115 ,p_commit IN VARCHAR2
116 ,p_init_msg_list IN VARCHAR2
117 ,p_validation_level IN NUMBER
118 ,P_counter_associations_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_associations_tbl
119 ,x_return_status OUT NOCOPY VARCHAR2
120 ,x_msg_count OUT NOCOPY NUMBER
121 ,x_msg_data OUT NOCOPY VARCHAR2
122 ,x_instance_association_id OUT NOCOPY NUMBER
123 );
124
125 --|---------------------------------------------------
126 --| procedure name: create_reading_lock
127 --| description : procedure used to
128 --| create reading lock on a counter
129 --|---------------------------------------------------
130 /*#
131 * This procedure is used to create Counter Reading Lock.
132 * @param p_api_version Current API version
133 * @param p_commit API commits if set to fnd_api.g_true
134 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
135 * @param p_validation_level API validation level
136 * @param p_ctr_reading_lock_rec Counter Reading Lock Record structure
137 * @param x_return_status API Return Status
138 * @param x_msg_count Message count
139 * @param x_msg_data Message Data
140 * @param x_reading_lock_id Counter Reading Lock Id
141 * @rep:scope public
142 * @rep:lifecycle active
143 * @rep:displayname Create Counter Reading Lock
144 */
145
146 PROCEDURE create_reading_lock
147 (
148 p_api_version IN NUMBER
149 ,p_commit IN VARCHAR2
150 ,p_init_msg_list IN VARCHAR2
151 ,p_validation_level IN NUMBER
152 ,p_ctr_reading_lock_rec IN OUT NOCOPY CSI_CTR_DATASTRUCTURES_PUB.ctr_reading_lock_rec
153 ,x_return_status OUT NOCOPY VARCHAR2
154 ,x_msg_count OUT NOCOPY NUMBER
155 ,x_msg_data OUT NOCOPY VARCHAR2
156 ,x_reading_lock_id OUT NOCOPY NUMBER
157 );
158
159 --|---------------------------------------------------
160 --| procedure name: create_daily_usage
161 --| description : procedure used to
162 --| create daily usage
163 --|---------------------------------------------------
164 /*#
165 * This procedure is used to create Daily Usage Forecast.
166 * @param p_api_version Current API version
167 * @param p_commit API commits if set to fnd_api.g_true
168 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
169 * @param p_validation_level API validation level
170 * @param p_ctr_usage_forecast_rec Daily Usage Forecast Record structure
171 * @param x_return_status API Return Status
172 * @param x_msg_count Message count
173 * @param x_msg_data Message Data
174 * @param x_instance_forecast_id Instance Daiy Usage Forecast Id
175 * @rep:scope public
176 * @rep:lifecycle active
177 * @rep:displayname Create Daily Usage Forecast
178 */
179
180 PROCEDURE create_daily_usage
181 (
182 p_api_version IN NUMBER
183 ,p_commit IN VARCHAR2
184 ,p_init_msg_list IN VARCHAR2
185 ,p_validation_level IN NUMBER
186 ,p_ctr_usage_forecast_rec IN OUT NOCOPY CSI_CTR_DATASTRUCTURES_PUB.ctr_usage_forecast_rec
187 ,x_return_status OUT NOCOPY VARCHAR2
188 ,x_msg_count OUT NOCOPY NUMBER
189 ,x_msg_data OUT NOCOPY VARCHAR2
190 ,x_instance_forecast_id OUT NOCOPY NUMBER
191 );
192
193 --|---------------------------------------------------
194 --| procedure name: update_counter
195 --| description : procedure used to
196 --| update counter
197 --|---------------------------------------------------
198 /*#
199 * This procedure is used to update Counter Instance.
200 * In this procedure, it can also update counter properties, associations,
201 * counter relationships, derived filters for a given counter
202 * @param p_api_version Current API version
203 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
204 * @param p_commit API commits if set to fnd_api.g_true
205 * @param p_validation_level API validation level
206 * @param p_counter_instance_rec Counter Record structure
207 * @param P_ctr_properties_tbl Counter Properties Table
208 * @param P_counter_relationships_tbl Contains the Counter Relationships Table
209 * @param P_ctr_derived_filters_tbl Contains the Counter Derived Filters Table
210 * @param P_counter_associations_tbl Contains the Counter Associations Table
211 * @param x_return_status API Return Status
212 * @param x_msg_count Message count
213 * @param x_msg_data Message Data
214 * @rep:scope public
215 * @rep:lifecycle active
216 * @rep:displayname Update Counter
217 */
218
219 PROCEDURE update_counter
220 (
221 p_api_version IN NUMBER
222 ,p_init_msg_list IN VARCHAR2
223 ,p_commit IN VARCHAR2
224 ,p_validation_level IN NUMBER
225 ,p_counter_instance_rec IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Counter_instance_rec
226 ,P_ctr_properties_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Ctr_properties_tbl
227 ,P_counter_relationships_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_relationships_tbl
228 ,P_ctr_derived_filters_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.ctr_derived_filters_tbl
229 ,P_counter_associations_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_associations_tbl
230 ,x_return_status out NOCOPY VARCHAR2
231 ,x_msg_count out NOCOPY NUMBER
232 ,x_msg_data out NOCOPY VARCHAR2
233 );
234
235 --|---------------------------------------------------
236 --| procedure name: update_ctr_property
237 --| description : procedure used to
238 --| update counter properties
239 --|---------------------------------------------------
240 /*#
241 * This procedure is used to update Counter Property.
242 * @param p_api_version Current API version
243 * @param p_commit API commits if set to fnd_api.g_true
244 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
245 * @param p_validation_level API validation level
246 * @param P_ctr_properties_tbl Counter Properties Table
247 * @param x_return_status API Return Status
248 * @param x_msg_count Message count
249 * @param x_msg_data Message Data
250 * @rep:scope public
251 * @rep:lifecycle active
252 * @rep:displayname Update Counter Property
253 */
254
255 PROCEDURE update_ctr_property
256 (
257 p_api_version IN NUMBER
258 ,p_commit IN VARCHAR2
259 ,p_init_msg_list IN VARCHAR2
260 ,p_validation_level IN NUMBER
261 ,P_ctr_properties_tbl IN out NOCOPY CSI_CTR_DATASTRUCTURES_PUB.Ctr_properties_tbl
262 ,x_return_status OUT NOCOPY VARCHAR2
263 ,x_msg_count OUT NOCOPY NUMBER
264 ,x_msg_data OUT NOCOPY VARCHAR2
265 );
266
267 --|---------------------------------------------------
268 --| procedure name: update_ctr_associations
269 --| description : procedure used to
270 --| update counter associations
271 --|---------------------------------------------------
272 /*#
273 * This procedure is used to update Counter Association.
274 * @param p_api_version Current API version
275 * @param p_commit API commits if set to fnd_api.g_true
276 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
277 * @param p_validation_level API validation level
278 * @param P_counter_associations_tbl Contains the Counter Associations Table
279 * @param x_return_status API Return Status
280 * @param x_msg_count Message count
281 * @param x_msg_data Message Data
282 * @rep:scope public
283 * @rep:lifecycle active
284 * @rep:displayname Update Counter Association
285 */
286
287 PROCEDURE update_ctr_associations
288 (
289 p_api_version IN NUMBER
290 ,p_commit IN VARCHAR2
291 ,p_init_msg_list IN VARCHAR2
292 ,p_validation_level IN NUMBER
293 ,p_counter_associations_tbl IN OUT NOCOPY CSI_CTR_DATASTRUCTURES_PUB.counter_associations_tbl
294 ,x_return_status OUT NOCOPY VARCHAR2
295 ,x_msg_count OUT NOCOPY NUMBER
296 ,x_msg_data OUT NOCOPY VARCHAR2
297 );
298
299
300 END CSI_COUNTER_PUB;
[Home] [Help]