[Home] [Help]
PACKAGE: APPS.OZF_ACTMETRIC_PVT
Source
1 PACKAGE OZF_ACTMETRIC_PVT AUTHID CURRENT_USER AS
2 /* $Header: ozfvamts.pls 115.1 2003/10/07 18:44:02 yzhao noship $ */
3
4 --
5 -- Start of comments.
6 --
7 -- NAME
8 -- Ozf_ActMetrics_Pvt 11.5.6
9 --
10 -- PURPOSE
11 -- This package is a private package used for defining constants, records,
12 -- types and procedures for activity metrics API.
13 --
14 -- Procedures:
15 -- Create_ActMetric
16 -- Update_ActMetric
17 -- Validate_ActMetric
18 -- Complete_ActMetric_Rec
19 -- Init_ActMetric_Rec
20 -- NOTES
21 --
22 --
23 -- HISTORY
24 -- 10/07/2002 KDASS/YZHAO migrate to ozf from ams_actmetrics_all
25
26 -- Begin section added by choang - 05/26/1999
27 --
28 -- Start OZF_ACT_METRICS_ALL
29 --
30 TYPE act_metric_rec_type
31 IS RECORD (
32 activity_metric_id NUMBER,
33 last_update_date DATE,
34 last_updated_by NUMBER,
35 creation_date DATE,
36 created_by NUMBER,
37 last_update_login NUMBER,
38 object_version_number NUMBER,
39 act_metric_used_by_id NUMBER,
40 arc_act_metric_used_by VARCHAR2(30),
41 purchase_req_raised_flag VARCHAR2(1),
42 application_id NUMBER,
43 sensitive_data_flag VARCHAR2(1),
44 budget_id NUMBER,
45 metric_id NUMBER,
46 transaction_currency_code VARCHAR2(15),
47 trans_forecasted_value NUMBER,
48 trans_committed_value NUMBER,
49 trans_actual_value NUMBER,
50 functional_currency_code VARCHAR2(15),
51 func_forecasted_value NUMBER,
52 dirty_flag VARCHAR2(1),
53 func_committed_value NUMBER,
54 func_actual_value NUMBER,
55 last_calculated_date DATE,
56 variable_value NUMBER,
57 computed_using_function_value NUMBER,
58 metric_uom_code VARCHAR2(3),
59 org_id NUMBER,
60 difference_since_last_calc NUMBER,
61 activity_metric_origin_id NUMBER,
62 arc_activity_metric_origin VARCHAR2(30),
63 days_since_last_refresh NUMBER,
64 scenario_id NUMBER,
65 SUMMARIZE_TO_METRIC NUMBER,
66 ROLLUP_TO_METRIC NUMBER,
67 hierarchy_id NUMBER,
68 start_node NUMBER,
69 from_level NUMBER,
70 to_level NUMBER,
71 from_date DATE,
72 TO_DATE DATE,
73 amount1 NUMBER,
74 amount2 NUMBER,
75 amount3 NUMBER,
76 percent1 NUMBER,
77 percent2 NUMBER,
78 percent3 NUMBER,
79 published_flag VARCHAR2(1),
80 pre_function_name VARCHAR2(4000),
81 post_function_name VARCHAR2(4000),
82 attribute_category VARCHAR2(30),
83 attribute1 VARCHAR2(150),
84 attribute2 VARCHAR2(150),
85 attribute3 VARCHAR2(150),
86 attribute4 VARCHAR2(150),
87 attribute5 VARCHAR2(150),
88 attribute6 VARCHAR2(150),
89 attribute7 VARCHAR2(150),
90 attribute8 VARCHAR2(150),
91 attribute9 VARCHAR2(150),
92 attribute10 VARCHAR2(150),
93 attribute11 VARCHAR2(150),
94 attribute12 VARCHAR2(150),
95 attribute13 VARCHAR2(150),
96 attribute14 VARCHAR2(150),
97 attribute15 VARCHAR2(150),
98 description VARCHAR2(4000),
99 act_metric_date DATE,
100 depend_act_metric NUMBER,
101 FUNCTION_USED_BY_ID NUMBER,
102 ARC_FUNCTION_USED_BY VARCHAR2(30),
103 /* 05/15/2002 yzhao: add 6 new columns for top-down bottom-up budgeting */
104 hierarchy_type VARCHAR2(30),
105 status_code VARCHAR2(30),
106 method_code VARCHAR2(30),
107 action_code VARCHAR2(30),
108 basis_year NUMBER,
109 ex_start_node VARCHAR2(1),
110 /* 05/15/2002 yzhao: add ends */
111 -- kdass added
112 product_spread_time_id NUMBER,
113 start_period_name VARCHAR2(30),
114 end_period_name VARCHAR2(30)
115 );
116
117
118 --
119 -- End OZF_ACT_METRICS_ALL
120 --
121 --
122 -- End of section added by choang.
123 --
124 --
125 -- End of comments.
126 --
127
128 -- Start of comments
129 -- NAME
130 -- Init_ActMetric_Rec
131 --
132 -- PURPOSE
133 -- This Procedure will initialize the Record for Activity Metric.
134 -- It will be called before call to Update Activity Metric
135 --
136 -- NOTES
137 --
138 -- HISTORY
139 -- 10/11/2000 SVEERAVE Created.
140 --
141 -- End of comments
142
143 PROCEDURE Init_ActMetric_Rec(
144 x_act_metric_rec IN OUT NOCOPY ozf_actmetric_pvt.Act_metric_rec_type
145 );
146
147 -- Start of comments
148 -- API Name Create_ActMetric
149 -- Type Private
150 -- Pre-reqs None.
151 -- Function Creates an association of a metric to a business
152 -- object by creating a record in OZF_ACT_METRICS_ALL.
153 -- Parameters
154 -- IN p_api_version IN NUMBER Required
155 -- p_init_msg_list IN VARCHAR2 Optional
156 -- Default := FND_API.G_FALSE
157 -- p_commit IN VARCHAR2 Optional
158 -- Default := FND_API.G_FALSE
159 -- p_validation_level IN NUMBER Optional
160 -- Default := FND_API.G_VALID_LEVEL_FULL
161 -- p_act_metric_rec IN act_metric_rec_type Required
162 -- OUT x_return_status OUT VARCHAR2
163 -- x_msg_count OUT NUMBER
164 -- x_msg_data OUT VARCHAR2
165 -- Version Current version: 1.0
166 -- Previous version: 1.0
167 -- Initial version: 1.0
168 -- End of comments
169
170
171 PROCEDURE Create_ActMetric (
172 p_api_version IN NUMBER,
173 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
174 --p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
175 p_commit IN VARCHAR2 := Fnd_Api.G_TRUE,
176 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
177
178 x_return_status OUT NOCOPY VARCHAR2,
179 x_msg_count OUT NOCOPY NUMBER,
180 x_msg_data OUT NOCOPY VARCHAR2,
181
182 p_act_metric_rec IN act_metric_rec_type,
183 x_activity_metric_id OUT NOCOPY NUMBER
184 );
185
186 -- Start of comments
187 -- API Name Update_ActMetric
188 -- Type Private
189 -- Pre-reqs None.
190 -- Function Updates the association of a metric to a business
191 -- object by creating a record in OZF_ACT_METRICS_ALL.
192 -- Parameters
193 -- IN p_api_version IN NUMBER Required
194 -- p_init_msg_list IN VARCHAR2 Optional
195 -- Default := FND_API.G_FALSE
196 -- p_commit IN VARCHAR2 Optional
197 -- Default := FND_API.G_FALSE
198 -- p_validation_level IN NUMBER Optional
199 -- Default := FND_API.G_VALID_LEVEL_FULL
200 -- p_act_metric_rec IN act_metric_rec_type Required
201 -- OUT x_return_status OUT VARCHAR2
202 -- x_msg_count OUT NUMBER
203 -- x_msg_data OUT VARCHAR2
204 -- Version Current version: 1.0
205 -- Previous version: 1.0
206 -- Initial version: 1.0
207 -- End of comments
208
209
210 PROCEDURE Update_ActMetric (
211 p_api_version IN NUMBER,
212 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
213 p_commit IN VARCHAR2 := Fnd_Api.G_FALSE,
214 p_validation_level IN NUMBER := Fnd_Api.G_VALID_LEVEL_FULL,
215
216 x_return_status OUT NOCOPY VARCHAR2,
217 x_msg_count OUT NOCOPY NUMBER,
218 x_msg_data OUT NOCOPY VARCHAR2,
219
220 p_act_metric_rec IN act_metric_rec_type
221 );
222
223 -- Start of comments
224 -- API Name Validate_ActMetric
225 -- Type Private
226 -- Pre-reqs None.
227 -- Function Validate items in metrics associated with business
228 -- objects.
229 -- Parameters
230 -- IN p_api_version IN NUMBER Required
231 -- p_init_msg_list IN VARCHAR2 Optional
232 -- Default := FND_API.G_FALSE
233 -- p_commit IN VARCHAR2 Optional
234 -- Default := FND_API.G_FALSE
235 -- p_validation_level IN NUMBER Optional
236 -- Default := FND_API.G_VALID_LEVEL_FULL
237 -- p_act_metric_rec IN act_metric_rec_type Required
238 -- OUT x_return_status OUT VARCHAR2
239 -- x_msg_count OUT NUMBER
240 -- x_msg_data OUT VARCHAR2
241 -- Version Current version: 1.0
242 -- Previous version: 1.0
243 -- Initial version: 1.0
244 -- End of comments
245
246
247 PROCEDURE Validate_ActMetric (
248 p_api_version IN NUMBER,
249 p_init_msg_list IN VARCHAR2 := Fnd_Api.G_FALSE,
250 p_validation_level IN NUMBER := Fnd_Api.G_Valid_Level_Full,
251
252 x_return_status OUT NOCOPY VARCHAR2,
253 x_msg_count OUT NOCOPY NUMBER,
254 x_msg_data OUT NOCOPY VARCHAR2,
255
256 p_act_metric_rec IN act_metric_rec_type
257 );
258
259
260 -- Start of comments
261 -- API Name Validate_ActMetric_Items
262 -- Type Private
263 -- Pre-reqs None.
264 -- Function Validate Activity Metric Items
265 -- Parameters
266 -- IN p_act_metric_rec IN act_metric_rec_type Required
267 -- p_validate_mode IN VARCHAR2
268 -- OUT x_return_status OUT VARCHAR2
269 -- Version Current version: 1.0
270 -- Previous version: 1.0
271 -- Initial version: 1.0
272 -- End of comments
273
274 PROCEDURE Validate_ActMetric_items(
275 p_act_metric_rec IN act_metric_rec_type,
276 p_validation_mode IN VARCHAR2 := Jtf_Plsql_Api.g_create,
277 x_return_status OUT NOCOPY VARCHAR2
278 ) ;
279
280 -- Start of comments
281 -- API Name Validate_ActMetric_Record
282 -- Type Private
283 -- Pre-reqs None.
284 -- Function Validate Activity Metric Records
285 -- Parameters
286 -- IN p_act_metric_rec IN act_metric_rec_type Required
287 -- p_complete_rec IN act_metric_rec_type Required
288 -- OUT x_return_status OUT VARCHAR2
289 -- Version Current version: 1.0
290 -- Previous version: 1.0
291 -- Initial version: 1.0
292 -- End of comments
293
294 PROCEDURE Validate_ActMetric_record(
295 p_act_metric_rec IN act_metric_rec_type,
296 p_complete_rec IN act_metric_rec_type,
297 x_return_status OUT NOCOPY VARCHAR2
298 ) ;
299
300
301 -- Start of comments
302 -- API Name Complete_ActMetric_Rec
303 -- Type Private
304 -- Pre-reqs None.
305 -- Function This Process returns the details for the Activity metric ID if
306 -- Not passed.
307 -- Parameters
308 -- IN p_act_metric_rec IN act_metric_rec_type Required
309 -- OUT x_complete_rec OUT act_metric_rec_type
310 -- Version Current version: 1.0
311 -- Previous version: 1.0
312 -- Initial version: 1.0
313 -- End of comments
314 PROCEDURE Complete_ActMetric_Rec(
315 p_act_metric_rec IN act_metric_rec_type,
316 x_complete_rec IN OUT NOCOPY act_metric_rec_type
317 );
318
319
320 END ozf_actmetric_pvt;