DBA Data[Home] [Help]

PACKAGE: APPS.BIS_TARGET_PUB

Source


1 PACKAGE BIS_TARGET_PUB AUTHID CURRENT_USER AS
2 /* $Header: BISPTARS.pls 115.30 2003/12/15 14:14:36 arhegde ship $ */
3 --
4 /*
5 REM dbdrv: sql ~PROD ~PATH ~FILE none none none package &phase=pls \
6 REM dbdrv: checkfile:~PROD:~PATH:~FILE
7 REM +=======================================================================+
8 REM |    Copyright (c) 1998 Oracle Corporation, Redwood Shores, CA, USA     |
9 REM |                         All rights reserved.                          |
10 REM +=======================================================================+
11 REM | FILENAME                                                              |
12 REM |     BISPTARS.pls                                                      |
13 REM |                                                                       |
14 REM | DESCRIPTION                                                           |
15 REM |     Public API for creating and managing Targets for the
16 REM |     Key Performance Framework.
17 REM | NOTES                                                                 |
18 REM |                                                                       |
19 REM | HISTORY                                                               |
20 REM | 02-DEC-98 irchen Creation
21 REM | 10-JAN-2003 rchandra for bug 2715432 , changed OUT parameter          |
22 REM |                       x_Target_Level_Rec , x_Target_Rec to IN OUT     |
23 REM |                       in API RETRIEVE_TARGET_FROM_SHNMS               |
24 REM |
25 REM | 15-Dec-2003 arhegde enh# 3148615 Change/Target based alerting.        |
26 REM +=======================================================================+
27 */
28 --
29 --
30 G_PKG_NAME CONSTANT VARCHAR2(30):='BIS_TARGET_PUB';
31 G_IS_PM_REGION CONSTANT VARCHAR2(10) := '1';
32 --
33 TYPE Target_Rec_Type IS RECORD
34 ( Target_ID                     NUMBER
35 , Target_Level_ID               NUMBER
36 , Target_Level_Short_Name       VARCHAR2(80)
37 , Target_Level_Name             VARCHAR2(100)
38 , Plan_ID                       NUMBER
39 , Plan_Short_Name               VARCHAR2(80)
40 , Plan_Name                     VARCHAR2(80)
41 , Org_level_value_id            VARCHAR2(250)
42 , Org_level_value_name          VARCHAR2(250)
43 , Time_level_Value_id           VARCHAR2(250)
44 , Time_level_Value_name         VARCHAR2(250)
45 , Dim1_Level_Value_ID           VARCHAR2(250)
46 , Dim1_Level_Value_Name         VARCHAR2(250)
47 , Dim2_Level_Value_ID           VARCHAR2(250)
48 , Dim2_Level_Value_Name         VARCHAR2(250)
49 , Dim3_Level_Value_ID           VARCHAR2(250)
50 , Dim3_Level_Value_Name         VARCHAR2(250)
51 , Dim4_Level_Value_ID           VARCHAR2(250)
52 , Dim4_Level_Value_Name         VARCHAR2(250)
53 , Dim5_Level_Value_ID           VARCHAR2(250)
54 , Dim5_Level_Value_Name         VARCHAR2(250)
55 , Dim6_Level_Value_ID           VARCHAR2(250)
56 , Dim6_Level_Value_Name         VARCHAR2(250)
57 , Dim7_Level_Value_ID           VARCHAR2(250)
58 , Dim7_Level_Value_Name         VARCHAR2(250)
59 , Target                        NUMBER
60 , Range1_low                    NUMBER
61 , Range1_high                   NUMBER
62 , Range2_low                    NUMBER
63 , Range2_high                   NUMBER
64 , Range3_low                    NUMBER
65 , Range3_high                   NUMBER
66 , Notify_Resp1_ID               NUMBER
67 , Notify_Resp1_Short_Name       VARCHAR2(100)
68 , Notify_Resp1_Name             VARCHAR2(240)
69 , Notify_Resp2_ID               NUMBER
70 , Notify_Resp2_Short_Name       VARCHAR2(100)
71 , Notify_Resp2_Name             VARCHAR2(240)
72 , Notify_Resp3_ID               NUMBER
73 , Notify_Resp3_Short_Name       VARCHAR2(100)
74 , Notify_Resp3_Name             VARCHAR2(240)
75 , Is_Pm_Region                  VARCHAR2(10)
76 );
77 --
78 
79 TYPE Target_Owners_Rec_Type IS RECORD
80 ( Range1_Owner_ID               NUMBER
81 , Range1_Owner_Short_Name       VARCHAR2(100)
82 , Range1_Owner_Name             VARCHAR2(240)
83 , Range2_Owner_ID               NUMBER
84 , Range2_Owner_Short_Name       VARCHAR2(100)
85 , Range2_Owner_Name             VARCHAR2(240)
86 , Range3_Owner_ID               NUMBER
87 , Range3_Owner_Short_Name       VARCHAR2(100)
88 , Range3_Owner_Name             VARCHAR2(240)
89 );
90 
91 TYPE Target_Tbl_Type IS TABLE of Target_Rec_Type
92         INDEX BY BINARY_INTEGER;
93 --
94 -- VALID RANGES FOR TARGETS
95 G_EXCEPTION_RANGE1        NUMBER := 1;
96 G_EXCEPTION_RANGE2        NUMBER := 2;
97 G_EXCEPTION_RANGE3        NUMBER := 3;
98 --
99 G_MISS_TARGET_REC         Target_Rec_Type;
100 --
101 G_MISS_TARGET_TBL         Target_Tbl_Type;
102 --
103 --
104 --   Defines one target for a specific set of dimension values for
105 --   one target level
106 PROCEDURE Create_Target
107 ( p_api_version   IN  NUMBER
108 , p_commit        IN  VARCHAR2 := FND_API.G_FALSE
109 , p_Target_Rec    IN  BIS_TARGET_PUB.Target_Rec_Type
110 , x_return_status OUT NOCOPY VARCHAR2
111 , x_error_Tbl     OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
112 );
113 --
114 --
115 -- retrieve information for all targets of the given target level
116 -- if information about dimension values are not required, set all_info
117 -- to FALSE.
118 PROCEDURE Retrieve_Targets
119 ( p_api_version      IN  NUMBER
120 , p_Target_Level_Rec IN  BIS_TARGET_LEVEL_PUB.Target_Level_Rec_Type
121 , p_all_info         IN  VARCHAR2 := FND_API.G_TRUE
122 , x_Target_Tbl       OUT NOCOPY BIS_TARGET_PUB.Target_Tbl_Type
123 , x_return_status    OUT NOCOPY VARCHAR2
124 , x_error_Tbl        OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
125 );
126 --
127 --
128 -- retrieve information for one target
129 -- If information about dimension values are not required, set all_info
130 -- to FALSE.
131 PROCEDURE Retrieve_Target
132 ( p_api_version   IN  NUMBER
133 , p_Target_Rec    IN  BIS_TARGET_PUB.Target_Rec_Type
134 , p_all_info      IN  VARCHAR2 := FND_API.G_TRUE
135 , x_Target_Rec    IN OUT NOCOPY BIS_TARGET_PUB.Target_Rec_Type
136 , x_return_status OUT NOCOPY VARCHAR2
137 , x_error_Tbl     OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
138 );
139 --
140 -- Modifies one target for a specific set of dimension values for
141 -- one target level
142 PROCEDURE Update_Target
143 ( p_api_version   IN  NUMBER
144 , p_commit        IN  VARCHAR2 := FND_API.G_FALSE
145 , p_Target_Rec    IN  BIS_TARGET_PUB.Target_Rec_Type
146 , x_return_status OUT NOCOPY VARCHAR2
147 , x_error_Tbl     OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
148 );
149 --
150 -- Deletes one target for a specific set of dimension values for
151 -- one target level
152 PROCEDURE Delete_Target
153 ( p_api_version   IN  NUMBER
154 , p_commit        IN  VARCHAR2 := FND_API.G_FALSE
155 , p_Target_Rec    IN  BIS_TARGET_PUB.Target_Rec_Type
156 , x_return_status OUT NOCOPY VARCHAR2
157 , x_error_Tbl     OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
158 );
159 --
160 -- Validates target record
161 PROCEDURE Validate_Target
162 ( p_api_version     IN  NUMBER
163 , p_Target_Rec      IN  BIS_TARGET_PUB.Target_Rec_Type
164 , x_return_status   OUT NOCOPY VARCHAR2
165 , x_error_Tbl       OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
166 );
167 --
168 
169 -- New Procedure to return TargetLevel and Target given the DimensionLevel ShortNames in any sequence
170 -- and the Measure Short Name
171 PROCEDURE Retrieve_Target_From_ShNms
172 ( p_api_version      IN  NUMBER
173 , p_target_level_rec IN  BIS_Target_Level_PUB.Target_Level_Rec_Type
174 , p_Target_Rec      IN BIS_TARGET_PUB.TARGET_REC_TYPE
175 , x_Target_Level_Rec IN OUT NOCOPY BIS_Target_Level_PUB.Target_Level_Rec_Type
176 , x_Target_Rec       IN OUT NOCOPY BIS_TARGET_PUB.TARGET_REC_TYPE
177 , x_return_status       OUT NOCOPY VARCHAR2
178 , x_error_Tbl           OUT NOCOPY BIS_UTILITIES_PUB.Error_Tbl_Type
179 ) ;
180 --
181 END BIS_TARGET_PUB;