[Home] [Help]
PACKAGE: APPS.EAM_METER_PUB
Source
1 PACKAGE EAM_METER_PUB AS
2 /* $Header: EAMPMETS.pls 120.5 2006/06/21 17:59:12 hkarmach noship $ */
3 /*#
4 * This package is used for the INSERT / UPDATE of meters.
5 * It defines 2 key procedures create_meter, update_meter
6 * which first validates and massages the IN parameters
7 * and then carries out the respective operations.
8 * @rep:scope public
9 * @rep:product EAM
10 * @rep:lifecycle active
11 * @rep:displayname EAM Meters
12 * @rep:category BUSINESS_ENTITY EAM_METER
13 */
14
15 G_PKG_NAME CONSTANT VARCHAR2(30):='EAM_Meter_Pub';
16
17
18 TYPE Meter_Rec_Type is RECORD
19 (
20 METER_ID NUMBER,
21 METER_NAME VARCHAR2(50),
22 METER_TYPE NUMBER,
23 METER_UOM VARCHAR2(3),
24 VALUE_CHANGE_DIR Number,
25 USED_IN_SCHEDULING VARCHAR2(1),
26 USER_DEFINED_RATE Number,
27 USE_PAST_READING Number,
28 DESCRIPTION VARCHAR2(240),
29 FROM_EFFECTIVE_DATE DATE,
30 TO_EFFECTIVE_DATE DATE,
31 ATTRIBUTE_CATEGORY VARCHAR2(30),
32 ATTRIBUTE1 VARCHAR2(150),
33 ATTRIBUTE2 VARCHAR2(150),
34 ATTRIBUTE3 VARCHAR2(150),
35 ATTRIBUTE4 VARCHAR2(150),
36 ATTRIBUTE5 VARCHAR2(150),
37 ATTRIBUTE6 VARCHAR2(150),
38 ATTRIBUTE7 VARCHAR2(150),
39 ATTRIBUTE8 VARCHAR2(150),
40 ATTRIBUTE9 VARCHAR2(150),
41 ATTRIBUTE10 VARCHAR2(150),
42 ATTRIBUTE11 VARCHAR2(150),
43 ATTRIBUTE12 VARCHAR2(150),
44 ATTRIBUTE13 VARCHAR2(150),
45 ATTRIBUTE14 VARCHAR2(150),
46 ATTRIBUTE15 VARCHAR2(150),
47 ATTRIBUTE16 VARCHAR2(150),
48 ATTRIBUTE17 VARCHAR2(150),
49 ATTRIBUTE18 VARCHAR2(150),
50 ATTRIBUTE19 VARCHAR2(150),
51 ATTRIBUTE20 VARCHAR2(150),
52 ATTRIBUTE21 VARCHAR2(150),
53 ATTRIBUTE22 VARCHAR2(150),
54 ATTRIBUTE23 VARCHAR2(150),
55 ATTRIBUTE24 VARCHAR2(150),
56 ATTRIBUTE25 VARCHAR2(150),
57 ATTRIBUTE26 VARCHAR2(150),
58 ATTRIBUTE27 VARCHAR2(150),
59 ATTRIBUTE28 VARCHAR2(150),
60 ATTRIBUTE29 VARCHAR2(150),
61 ATTRIBUTE30 VARCHAR2(150),
62 TMPL_FLAG VARCHAR2(1),
63 SOURCE_TMPL_ID NUMBER,
64 INITIAL_READING NUMBER,
65 EAM_REQUIRED_FLAG VARCHAR2(1)
66 );
67
68
69 /*#
70 * This procedure is used to create EAM Meters.
71 * @param p_api_version Version of the API
72 * @param p_init_msg_list Flag to indicate initialization of message list
73 * @param p_commit Flag to indicate whether API should commit changes
74 * @param p_validation_level Validation Level of the API
75 * @param x_return_status Return status of the procedure call
76 * @param x_msg_count Count of the return messages that API returns
77 * @param x_msg_data The collection of the messages.
78 * @param p_meter_name Name of the meter
79 * @param p_meter_uom Unit Of Measure used to track usage
80 * @param p_meter_type Meter type. 1 indicates absolute meter, 2 indicates change meter
81 * @param p_VALUE_CHANGE_DIR Value Change Direction. 1 indicates ascending, 2 indicates descending, null indicates fluctuating
82 * @param p_USED_IN_SCHEDULING Used in Scheduling Flag
83 * @param p_USER_DEFINED_RATE Usage Rate
84 * @param p_USE_PAST_READING Indicator of how many past reading should be used to compute rate
85 * @param p_DESCRIPTION Meter description
86 * @param p_FROM_EFFECTIVE_DATE Effective start date
87 * @param p_TO_EFFECTIVE_DATE Effective end date
88 * @param p_source_meter_id Source Meter Id
89 * @param p_factor Factor by which source meter reading will be trickeled down to this meter
90 * @param p_relationship_start_date Start date of meter hierarchy
91 * @param p_attribute_category Attribute Category
92 * @param p_attribute1 Descriptive flexfield column
93 * @param p_attribute2 Descriptive flexfield column
94 * @param p_attribute3 Descriptive flexfield column
95 * @param p_attribute4 Descriptive flexfield column
96 * @param p_attribute5 Descriptive flexfield column
97 * @param p_attribute6 Descriptive flexfield column
98 * @param p_attribute7 Descriptive flexfield column
99 * @param p_attribute8 Descriptive flexfield column
100 * @param p_attribute9 Descriptive flexfield column
101 * @param p_attribute10 Descriptive flexfield column
102 * @param p_attribute11 Descriptive flexfield column
103 * @param p_attribute12 Descriptive flexfield column
104 * @param p_attribute13 Descriptive flexfield column
105 * @param p_attribute14 Descriptive flexfield column
106 * @param p_attribute15 Descriptive flexfield column
107 * @param p_attribute16 Descriptive flexfield column
108 * @param p_attribute17 Descriptive flexfield column
109 * @param p_attribute18 Descriptive flexfield column
110 * @param p_attribute19 Descriptive flexfield column
111 * @param p_attribute20 Descriptive flexfield column
112 * @param p_attribute21 Descriptive flexfield column
113 * @param p_attribute22 Descriptive flexfield column
114 * @param p_attribute23 Descriptive flexfield column
115 * @param p_attribute24 Descriptive flexfield column
116 * @param p_attribute25 Descriptive flexfield column
117 * @param p_attribute26 Descriptive flexfield column
118 * @param p_attribute27 Descriptive flexfield column
119 * @param p_attribute28 Descriptive flexfield column
120 * @param p_attribute29 Descriptive flexfield column
121 * @param p_attribute30 Descriptive flexfield column
122 * @param p_TMPL_FLAG Flag indicating if this is a template meter
123 * @param p_SOURCE_TMPL_ID The meter template identifier from which this meter is created
124 * @param p_INITIAL_READING The first meter reading upon meter creation
125 * @param p_INITIAL_READING_DATE Date of Initial Reading
126 * @param x_new_meter_id Meter Identifier
127 * @return Returns the Primary Key of newly created record and status of the procedure call as well as the return messages
128 * @rep:scope public
129 * @rep:displayname Create EAM Meters
130 */
131
132 procedure create_meter(
133 p_api_version IN Number,
134 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
135 p_commit IN VARCHAR2 := FND_API.G_FALSE,
136 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
137 x_return_status OUT nocopy VARCHAR2,
138 x_msg_count OUT nocopy NUMBER,
139 x_msg_data OUT nocopy VARCHAR2,
140 p_meter_name IN VARCHAR2,
141 p_meter_uom IN VARCHAR2,
142 p_METER_TYPE IN Number default 1,
143 p_VALUE_CHANGE_DIR IN Number DEFAULT 1,
144 p_USED_IN_SCHEDULING IN VARCHAR2 default 'N',
145 p_USER_DEFINED_RATE IN Number default null,
146 p_USE_PAST_READING IN Number default null,
147 p_DESCRIPTION IN VARCHAR2 default null,
148 p_FROM_EFFECTIVE_DATE IN DATE default null,
149 p_TO_EFFECTIVE_DATE IN DATE default null,
150 p_source_meter_id IN Number DEFAULT NULL,
151 p_factor IN NUMBER DEFAULT 1,
152 p_relationship_start_date IN DATE default null,
153 p_ATTRIBUTE_CATEGORY IN VARCHAR2 default null,
154 p_ATTRIBUTE1 IN VARCHAR2 default null,
155 p_ATTRIBUTE2 IN VARCHAR2 default null,
156 p_ATTRIBUTE3 IN VARCHAR2 default null,
157 p_ATTRIBUTE4 IN VARCHAR2 default null,
158 p_ATTRIBUTE5 IN VARCHAR2 default null,
159 p_ATTRIBUTE6 IN VARCHAR2 default null,
160 p_ATTRIBUTE7 IN VARCHAR2 default null,
161 p_ATTRIBUTE8 IN VARCHAR2 default null,
162 p_ATTRIBUTE9 IN VARCHAR2 default null,
163 p_ATTRIBUTE10 IN VARCHAR2 default null,
164 p_ATTRIBUTE11 IN VARCHAR2 default null,
165 p_ATTRIBUTE12 IN VARCHAR2 default null,
166 p_ATTRIBUTE13 IN VARCHAR2 default null,
167 p_ATTRIBUTE14 IN VARCHAR2 default null,
168 p_ATTRIBUTE15 IN VARCHAR2 default null,
169 p_ATTRIBUTE16 IN VARCHAR2 default null,
170 p_ATTRIBUTE17 IN VARCHAR2 default null,
171 p_ATTRIBUTE18 IN VARCHAR2 default null,
172 p_ATTRIBUTE19 IN VARCHAR2 default null,
173 p_ATTRIBUTE20 IN VARCHAR2 default null,
174 p_ATTRIBUTE21 IN VARCHAR2 default null,
175 p_ATTRIBUTE22 IN VARCHAR2 default null,
176 p_ATTRIBUTE23 IN VARCHAR2 default null,
177 p_ATTRIBUTE24 IN VARCHAR2 default null,
178 p_ATTRIBUTE25 IN VARCHAR2 default null,
179 p_ATTRIBUTE26 IN VARCHAR2 default null,
180 p_ATTRIBUTE27 IN VARCHAR2 default null,
181 p_ATTRIBUTE28 IN VARCHAR2 default null,
182 p_ATTRIBUTE29 IN VARCHAR2 default null,
183 p_ATTRIBUTE30 IN VARCHAR2 default null,
184 p_TMPL_FLAG IN VARCHAR2 default 'N',
185 p_SOURCE_TMPL_ID IN Number default null,
186 p_INITIAL_READING IN Number default 0,
187 P_INITIAL_READING_DATE IN DATE default SYSDATE,
188 P_EAM_REQUIRED_FLAG IN VARCHAR2 default 'N',
189 x_new_meter_id OUT nocopy Number);
190
191 /*#
192 * This procedure is used to update EAM Meters.
193 * @param p_api_version Version of the API
194 * @param p_init_msg_list Flag to indicate initialization of message list
195 * @param p_commit Flag to indicate whether API should commit changes
196 * @param p_validation_level Validation Level of the API
197 * @param x_return_status Return status of the procedure call
198 * @param x_msg_count Count of the return messages that API returns
199 * @param x_msg_data The collection of the messages.
200 * @param p_meter_id Meter Identifier
201 * @param p_meter_name Name of the meter
202 * @param p_meter_uom Unit Of Measure used to track usage
203 * @param p_meter_type Meter type. 1 indicates absolute meter, 2 indicates change meter
204 * @param p_VALUE_CHANGE_DIR Value Change Direction. 1 indicates ascending, 2 indicates descending, null indicates fluctuating
205 * @param p_USED_IN_SCHEDULING Used in Scheduling Flag
206 * @param p_USER_DEFINED_RATE Usage Rate
207 * @param p_USE_PAST_READING Indicator of how many past reading should be used to compute rate
208 * @param p_DESCRIPTION Meter description
209 * @param p_FROM_EFFECTIVE_DATE Effective start date
210 * @param p_TO_EFFECTIVE_DATE Effective end date
211 * @param p_source_meter_id Source Meter Id
212 * @param p_factor Factor by which source meter reading will be trickeled down to this meter
213 * @param p_relationship_start_date Start date of meter hierarchy
214 * @param p_attribute_category Attribute Category
215 * @param p_attribute1 Descriptive flexfield column
216 * @param p_attribute2 Descriptive flexfield column
217 * @param p_attribute3 Descriptive flexfield column
218 * @param p_attribute4 Descriptive flexfield column
219 * @param p_attribute5 Descriptive flexfield column
220 * @param p_attribute6 Descriptive flexfield column
221 * @param p_attribute7 Descriptive flexfield column
222 * @param p_attribute8 Descriptive flexfield column
223 * @param p_attribute9 Descriptive flexfield column
224 * @param p_attribute10 Descriptive flexfield column
225 * @param p_attribute11 Descriptive flexfield column
226 * @param p_attribute12 Descriptive flexfield column
227 * @param p_attribute13 Descriptive flexfield column
228 * @param p_attribute14 Descriptive flexfield column
229 * @param p_attribute15 Descriptive flexfield column
230 * @param p_attribute16 Descriptive flexfield column
231 * @param p_attribute17 Descriptive flexfield column
232 * @param p_attribute18 Descriptive flexfield column
233 * @param p_attribute19 Descriptive flexfield column
234 * @param p_attribute20 Descriptive flexfield column
235 * @param p_attribute21 Descriptive flexfield column
236 * @param p_attribute22 Descriptive flexfield column
237 * @param p_attribute23 Descriptive flexfield column
238 * @param p_attribute24 Descriptive flexfield column
239 * @param p_attribute25 Descriptive flexfield column
240 * @param p_attribute26 Descriptive flexfield column
241 * @param p_attribute27 Descriptive flexfield column
242 * @param p_attribute28 Descriptive flexfield column
243 * @param p_attribute29 Descriptive flexfield column
244 * @param p_attribute30 Descriptive flexfield column
245 * @param p_TMPL_FLAG Flag indicating if this meter is a template or not
246 * @param p_SOURCE_TMPL_ID The meter template identifier from which this meter has been created
247 * @param p_from_eam Call is from EAM or not
248 * @return Returns the status of the procedure call as well as the return messages
249 * @rep:scope public
250 * @rep:displayname Update EAM Meters
251 */
252
253 procedure update_meter (
254 p_api_version IN Number,
255 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
256 p_commit IN VARCHAR2 := FND_API.G_FALSE,
257 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
258 x_return_status OUT nocopy VARCHAR2,
259 x_msg_count OUT nocopy Number,
260 x_msg_data OUT nocopy VARCHAR2,
261 p_meter_id IN number,
262 p_meter_name IN varchar default null,
263 p_meter_uom IN varchar default null,
264 p_METER_TYPE IN number default NULL,
265 p_VALUE_CHANGE_DIR IN Number default NULL,
266 p_USED_IN_SCHEDULING IN VARCHAR2 default NULL,
267 p_USER_DEFINED_RATE IN Number default null,
268 p_USE_PAST_READING IN Number default null,
269 p_DESCRIPTION IN VARCHAR2 default null,
270 p_FROM_EFFECTIVE_DATE IN DATE default null,
271 p_TO_EFFECTIVE_DATE IN DATE default null,
272 p_source_meter_id IN Number DEFAULT NULL,
273 p_factor IN NUMBER DEFAULT NULL,
274 p_relationship_start_date IN DATE default null,
275 p_ATTRIBUTE_CATEGORY IN VARCHAR2 default null,
276 p_ATTRIBUTE1 IN VARCHAR2 default null,
277 p_ATTRIBUTE2 IN VARCHAR2 default null,
278 p_ATTRIBUTE3 IN VARCHAR2 default null,
279 p_ATTRIBUTE4 IN VARCHAR2 default null,
280 p_ATTRIBUTE5 IN VARCHAR2 default null,
281 p_ATTRIBUTE6 IN VARCHAR2 default null,
282 p_ATTRIBUTE7 IN VARCHAR2 default null,
283 p_ATTRIBUTE8 IN VARCHAR2 default null,
284 p_ATTRIBUTE9 IN VARCHAR2 default null,
285 p_ATTRIBUTE10 IN VARCHAR2 default null,
286 p_ATTRIBUTE11 IN VARCHAR2 default null,
287 p_ATTRIBUTE12 IN VARCHAR2 default null,
288 p_ATTRIBUTE13 IN VARCHAR2 default null,
289 p_ATTRIBUTE14 IN VARCHAR2 default null,
290 p_ATTRIBUTE15 IN VARCHAR2 default null,
291 p_ATTRIBUTE16 IN VARCHAR2 default null,
292 p_ATTRIBUTE17 IN VARCHAR2 default null,
293 p_ATTRIBUTE18 IN VARCHAR2 default null,
294 p_ATTRIBUTE19 IN VARCHAR2 default null,
295 p_ATTRIBUTE20 IN VARCHAR2 default null,
296 p_ATTRIBUTE21 IN VARCHAR2 default null,
297 p_ATTRIBUTE22 IN VARCHAR2 default null,
298 p_ATTRIBUTE23 IN VARCHAR2 default null,
299 p_ATTRIBUTE24 IN VARCHAR2 default null,
300 p_ATTRIBUTE25 IN VARCHAR2 default null,
301 p_ATTRIBUTE26 IN VARCHAR2 default null,
302 p_ATTRIBUTE27 IN VARCHAR2 default null,
303 p_ATTRIBUTE28 IN VARCHAR2 default null,
304 p_ATTRIBUTE29 IN VARCHAR2 default null,
305 p_ATTRIBUTE30 IN VARCHAR2 default null,
306 p_TMPL_FLAG IN VARCHAR2 default 'N',
307 p_SOURCE_TMPL_ID IN Number default NULL,
308 p_EAM_REQUIRED_FLAG IN VARCHAR2 default 'N',
309 p_from_eam IN varchar2 default null
310 );
311
312
313 END EAM_METER_PUB;
314