DBA Data[Home] [Help]

PACKAGE: APPS.BSC_PERIODICITIES_PUB

Source


1 PACKAGE BSC_PERIODICITIES_PUB AS
2 /* $Header: BSCPPERS.pls 120.4.12000000.3 2007/05/16 12:52:56 ppandey ship $ */
3 /*
4 REM +=======================================================================+
5 REM |    Copyright (c) 2002 Oracle Corporation, Redwood Shores, CA, USA     |
6 REM |                         All rights reserved.                          |
7 REM +=======================================================================+
8 REM | FILENAME                                                              |
9 REM |     BSCPPERS.pls                                                      |
10 REM |                                                                       |
11 REM | DESCRIPTION                                                           |
12 REM |     Module: PUBLIC specification to manage periodicities              |
13 REM | NOTES                                                                 |
14 REM | 14-JUL-2005 Aditya Rao  Created.                                      |
15 REM | 12-AUG-2005 Aditya Rao added API Get_Incr_Change                      |
16 REM | 29-NOV-2005 Krishna Modified for enh#4711274                          |
17 REM | 07-FEB-2006 ashankar Fix for the bug4695330                           |
18 REM | 21-MAR-2006 ashankar  Fixed bug#5099465 Modified Validate_Periodicity |
19 REM +=======================================================================+
20 */
21 
22 G_PKG_NAME CONSTANT VARCHAR2(30):='BSC_PERIODICITIES_PUB';
23 
24 
25 TYPE Periodicities_Rec_Type IS RECORD
26 (
27       Periodicity_Id             BSC_SYS_PERIODICITIES.PERIODICITY_ID%TYPE
28     , Num_Of_Periods             BSC_SYS_PERIODICITIES.NUM_OF_PERIODS%TYPE
29     , Source                     BSC_SYS_PERIODICITIES.SOURCE%TYPE
30     , Base_Periodicity_Id        BSC_SYS_PERIODICITIES.PERIODICITY_ID%TYPE
31     , Num_Of_Subperiods          BSC_SYS_PERIODICITIES.NUM_OF_SUBPERIODS%TYPE
32     , Period_Col_Name            BSC_SYS_PERIODICITIES.PERIOD_COL_NAME%TYPE
33     , Subperiod_Col_Name         BSC_SYS_PERIODICITIES.SUBPERIOD_COL_NAME%TYPE
34     , Yearly_Flag                BSC_SYS_PERIODICITIES.YEARLY_FLAG%TYPE
35     , Edw_Flag                   BSC_SYS_PERIODICITIES.EDW_FLAG%TYPE
36     , Calendar_Id                BSC_SYS_PERIODICITIES.CALENDAR_ID%TYPE
37     , Edw_Periodicity_Id         BSC_SYS_PERIODICITIES.EDW_PERIODICITY_ID%TYPE
38     , Custom_Code                BSC_SYS_PERIODICITIES.CUSTOM_CODE%TYPE
39     , Db_Column_Name             BSC_SYS_PERIODICITIES.DB_COLUMN_NAME%TYPE
40     , Periodicity_Type           BSC_SYS_PERIODICITIES.PERIODICITY_TYPE%TYPE
41     , Period_Type_Id             BSC_SYS_PERIODICITIES.PERIOD_TYPE_ID%TYPE
42     , Record_Type_Id             BSC_SYS_PERIODICITIES.RECORD_TYPE_ID%TYPE
43     , Xtd_Pattern                BSC_SYS_PERIODICITIES.XTD_PATTERN%TYPE
44     , Short_Name                 BSC_SYS_PERIODICITIES.SHORT_NAME%TYPE
45     , Name                       BSC_SYS_PERIODICITIES_TL.NAME%TYPE
46     , Description                BIS_LEVELS_TL.DESCRIPTION%TYPE
47     , Created_By                 BSC_SYS_PERIODICITIES_TL.CREATED_BY%TYPE
48     , Creation_Date              BSC_SYS_PERIODICITIES_TL.CREATION_DATE%TYPE
49     , Last_Updated_By            BSC_SYS_PERIODICITIES_TL.LAST_UPDATED_BY%TYPE
50     , Last_Update_Date           BSC_SYS_PERIODICITIES_TL.LAST_UPDATE_DATE%TYPE
51     , Last_Update_Login          BSC_SYS_PERIODICITIES_TL.LAST_UPDATE_LOGIN%TYPE
52     , Application_id             BIS_LEVELS.APPLICATION_ID%TYPE
53     , Period_Year                BSC_SYS_PERIODS.YEAR%TYPE
54     , Start_Period               BSC_SYS_PERIODS.START_PERIOD%TYPE
55     , End_Period                 BSC_SYS_PERIODS.END_PERIOD%TYPE
56     , Period_IDs                 VARCHAR2(8000)
57     , ForceRunPopulateCalendar   VARCHAR2(1) := FND_API.G_TRUE
58 );
59 
60 
61 /*
62 Procedure Name
63 Parameters
64 
65 */
66 
67 PROCEDURE Create_Periodicity (
68   p_Api_Version             IN          NUMBER
69  ,p_Commit                  IN          VARCHAR2
70  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
71  ,x_Return_Status           OUT NOCOPY  VARCHAR2
72  ,x_Msg_Count               OUT NOCOPY  NUMBER
73  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
74 );
75 
76 
77 --PROCEDURE Validate_Periodicity
78 
79 PROCEDURE Validate_Periodicity (
80   p_Api_Version             IN          NUMBER
81  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
82  ,p_Action_Type             IN          VARCHAR2
83  ,x_Return_Status           OUT NOCOPY  VARCHAR2
84  ,x_Msg_Count               OUT NOCOPY  NUMBER
85  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
86 );
87 
88 --PROCEDURE Update_Periodicity
89 
90 PROCEDURE Populate_Periodicity_Record (
91   p_Api_Version             IN          NUMBER
92  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
93  ,x_Periodicities_Rec_Type  OUT NOCOPY  BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
94  ,x_Return_Status           OUT NOCOPY  VARCHAR2
95  ,x_Msg_Count               OUT NOCOPY  NUMBER
96  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
97 );
98 
99 -- populates the BSC_SYS_PERIODS metadata
100 PROCEDURE Populate_Period_Metadata (
101   p_Api_Version             IN          NUMBER
102  ,p_Commit                  IN          VARCHAR2
103  ,p_Action_Type             IN          VARCHAR2
104  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
105  ,p_disable_period_val_flag IN          VARCHAR2
106  ,x_Return_Status           OUT NOCOPY  VARCHAR2
107  ,x_Msg_Count               OUT NOCOPY  NUMBER
108  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
109 );
110 
111 
112 
113 --PROCEDURE Update_Periodicity
114 
115 PROCEDURE Update_Periodicity (
116   p_Api_Version             IN          NUMBER
117  ,p_Commit                  IN          VARCHAR2 := FND_API.G_FALSE
118  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
119  ,x_Return_Status           OUT NOCOPY  VARCHAR2
120  ,x_Msg_Count               OUT NOCOPY  NUMBER
121  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
122 );
123 
124 --PROCEDURE Retrieve_Periodicity
125 
126 PROCEDURE Retrieve_Periodicity (
127   p_Api_Version             IN          NUMBER
128  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
129  ,x_Periodicities_Rec_Type  OUT NOCOPY  BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
130  ,x_Return_Status           OUT NOCOPY  VARCHAR2
131  ,x_Msg_Count               OUT NOCOPY  NUMBER
132  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
133 );
134 
135 
136 
137 --PROCEDURE Delete_Periodicity
138 PROCEDURE Delete_Periodicity (
139   p_Api_Version             IN          NUMBER
140  ,p_Commit                  IN          VARCHAR2
141  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
142  ,x_Return_Status           OUT NOCOPY  VARCHAR2
143  ,x_Msg_Count               OUT NOCOPY  NUMBER
144  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
145 );
146 
147 
148 PROCEDURE Get_Incr_Change (
149    p_Periodicity_Id       IN NUMBER
150   ,p_Calendar_ID          IN NUMBER
151   ,p_Base_Periodicity_Id  IN NUMBER
152   ,p_Num_Of_Periods       IN NUMBER
153   ,p_Period_Ids           IN VARCHAR2
154   ,p_Return_Values        IN VARCHAR2
155   ,x_Message_Name         OUT NOCOPY VARCHAR2
156   ,x_Objective_List       OUT NOCOPY VARCHAR2
157 );
158 
159 /******************************************************************
160          Fix for the bug 4695330
161 /*****************************************************************/
162 
163 PROCEDURE Create_Periodicity (
164   p_Api_Version             IN          NUMBER
165  ,p_Commit                  IN          VARCHAR2
166  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
167  ,p_disable_period_val_flag IN          VARCHAR2
168  ,x_Return_Status           OUT NOCOPY  VARCHAR2
169  ,x_Msg_Count               OUT NOCOPY  NUMBER
170  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
171 );
172 
173 PROCEDURE Update_Periodicity (
174   p_Api_Version             IN          NUMBER
175  ,p_Commit                  IN          VARCHAR2 := FND_API.G_FALSE
176  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
177  ,p_disable_period_val_flag IN          VARCHAR2
178  ,x_Return_Status           OUT NOCOPY  VARCHAR2
179  ,x_Msg_Count               OUT NOCOPY  NUMBER
180  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
181 );
182 
183 
184 PROCEDURE Validate_Periodicity (
185   p_Api_Version             IN          NUMBER
186  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
187  ,p_Action_Type             IN          VARCHAR2
188  ,p_disable_period_val_flag IN          VARCHAR2
189  ,x_Return_Status           OUT NOCOPY  VARCHAR2
190  ,x_Msg_Count               OUT NOCOPY  NUMBER
191  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
192 );
193 
194 PROCEDURE Translate_Periodicity (
195   p_Api_Version             IN          NUMBER
196  ,p_Commit                  IN          VARCHAR2 := FND_API.G_FALSE
197  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
198  ,p_disable_period_val_flag IN          VARCHAR2
199  ,x_Return_Status           OUT NOCOPY  VARCHAR2
200  ,x_Msg_Count               OUT NOCOPY  NUMBER
201  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
202 );
203 
204 PROCEDURE Load_Periodicity (
205   p_Api_Version             IN          NUMBER
206  ,p_Commit                  IN          VARCHAR2 := FND_API.G_FALSE
207  ,p_Periodicities_Rec_Type  IN          BSC_PERIODICITIES_PUB.Periodicities_Rec_Type
208  ,p_disable_period_val_flag IN          VARCHAR2
209  ,x_Return_Status           OUT NOCOPY  VARCHAR2
210  ,x_Msg_Count               OUT NOCOPY  NUMBER
211  ,x_Msg_Data                OUT NOCOPY  VARCHAR2
212 );
213 
214 END BSC_PERIODICITIES_PUB;