DBA Data[Home] [Help]

PACKAGE: APPS.IGS_PS_SCH_INT_API_PUB

Source


1 PACKAGE IGS_PS_SCH_INT_API_PUB AS
2 /* $Header: IGSPS80S.pls 120.2 2006/01/17 05:53:04 sommukhe noship $ */
3 /*#
4  * A public API to import data into Scheduling Occurrence Interface Table.
5  * @rep:scope public
6  * @rep:product IGS
7  * @rep:displayname Import Schedule
8  * @rep:lifecycle active
9  * @rep:compatibility S
10  * @rep:category BUSINESS_ENTITY IGS_UNIT
11  */
12 -- Start of Comments
13 -- API Name               : Insert_Schedule
14 -- Type                   : Public
15 -- Pre-reqs               : None
16 -- Function               : Inserts data into the Schedule Interface Tables
17 -- Parameters             :
18 -- IN                       p_api_version
19 -- IN                       p_init_msg_list
20 -- IN                       p_commit
21 -- IN                       p_validation_level
22 -- IN                       p_transaction_type
23 --                          This parameter contains the type of transaction
24 --                          i.e.REQUEST,COMPLETE,UPDATE OR CANCEL
25 -- IN                       p_cal_type
26 --                          This contains the Calendar Type of the Unit Section Record
27 -- IN                       p_sequence_number
28 --                          This contains the Sequence number of the Calendar Instance of the
29 --                          Unit Section Record
30 -- IN                       p_cal_start_dt
31 --                          This parameter contains the Start Date of the Calendar
32 --                          Instance of the Unit Section Record
33 -- IN                       p_cal_end_dt
34 --                          This parameter contains the End Date of the Calendar
35 --                          Instance of the Unit Section Record
36 -- IN                       p_uoo_id
37 --                          This parameter contains the Unit Section Id of the
38 --                          Unit Section Record
39 -- IN                       p_unit_section_occurrence_id
40 --                          This parameter contains the Unit Section Occurrence ID of the
41 --                          Unit Section Occurrence record
42 -- IN                       p_start_time
43 --                          This parameter contains the Scheduled Start Time
44 --                          of the Unit Section Occurrence
45 -- IN                       p_end_time
46 --                          This parameter contains the Scheduled End Time
47 --                          of the Unit Section Occurrence
48 -- IN                       p_building_id
49 --                          This parameter contains the Scheduled Building id
50 --                          of the Unit Section Occurrence
51 -- IN                       p_room_id
52 --                          This parameter contains the Scheduled Room id
53 --                          of the Unit Section Occurrence
54 -- IN                       p_schedule_status
55 --                          This parameter contains the schedule status of the
56 --                          Unit Section Occurrence
57 -- IN                       p_error_text
58 --                          This parameter contains the error text, in case of Scheduling Error of the
59 --                          Unit Section Occurrence
60 -- IN                       p_org_id
61 --                          This parameter contains the Operating Unit Identifier
62 -- IN                       p_uso_start_date
63 --                          This parameter contains unit section occurrence start date
64 -- IN                       p_uso_end_date
65 --                          This parameter contains unit section occurrence end date
66 -- IN                       p_sunday
67 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
68 --                          on sunday
69 -- IN                       p_monday
70 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
71 --                          on monday
72 -- IN                       p_tuesday
73 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
74 --                          on tuesday
75 -- IN                       p_wednesday
76 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
77 --                          on wednesday
78 -- IN                       p_thursday
79 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
80 --                          on thursday
81 -- IN                       p_friday
82 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
83 --                          on friday
84 -- IN                       p_saturday
85 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
86 --                          on saturday
87 -- OUT NOCOPY               x_return_status
88 --                          returns the status of the charges API - S if Successful,
89 --                          E if Expected Error and U if Unexpected Error
90 -- OUT NOCOPY               x_msg_count
91 -- OUT NOCOPY               x_msg_data
92 -- Version                  Current Version 1.0
93 -- End of Comments
94 
95 -- Enh bug#2833850
96 -- Added following parameters
97 -- p_uso_start_date,p_uso_end_date,p_sunday,p_monday,p_tuesday,p_wednesday,p_thursday,p_friday,p_saturday
98 /*#
99  * A public API to import(insert) data into Scheduling Occurrence Interface Table.
100  * @param p_API_VERSION API Version Number
101  * @param p_INIT_MSG_LIST Initialize Message List
102  * @param p_COMMIT Commit Transaction
103  * @param p_VALIDATION_LEVEL Validation Level
104  * @param X_RETURN_STATUS Return Status
105  * @param X_MSG_COUNT Message Count
106  * @param X_MSG_DATA Message Data
107  * @param p_TRANSACTION_TYPE Transaction type
108  * @param p_CAL_TYPE Calendar Type
109  * @param p_SEQUENCE_NUMBER Calendar Sequence Number
110  * @param p_CAL_START_DT Unit Section Start Date
111  * @param p_CAL_END_DT Unit Section End Date
112  * @param p_UOO_ID Unit Section Identifier
113  * @param p_UNIT_SECTION_OCCURRENCE_ID Unit Section Occurrence Identifier
114  * @param p_START_TIME Start Time
115  * @param p_END_TIME End Time
116  * @param p_BUILDING_ID Building Identifier
117  * @param p_ROOM_ID Room Identifier
118  * @param p_SCHEDULE_STATUS Schedule Status
119  * @param p_ERROR_TEXT Error Text
120  * @param p_ORG_ID Operation Unit Identifier
121  * @param p_USO_START_DATE Occurrence Start Date
122  * @param p_USO_END_DATE Occurrence End Date
123  * @param p_SUNDAY Sunday
124  * @param p_MONDAY Monday
125  * @param p_TUESDAY Tuesday
126  * @param p_WEDNESDAY Wednesday
127  * @param p_THURSDAY Thursday
128  * @param p_FRIDAY Friday
129  * @param p_SATURDAY Saturday
130  * @rep:scope public
131  * @rep:lifecycle active
132  * @rep:displayname Insert Schedule
133  */
134   PROCEDURE Insert_schedule(p_api_version                IN               NUMBER,
135                             p_init_msg_list              IN               VARCHAR2 := FND_API.G_FALSE,
136                             p_commit                     IN               VARCHAR2 := FND_API.G_FALSE,
137                             p_validation_level           IN               NUMBER := FND_API.G_VALID_LEVEL_FULL,
138                             x_return_status              OUT NOCOPY       VARCHAR2,
139                             x_msg_count                  OUT NOCOPY       NUMBER,
140                             x_msg_data                   OUT NOCOPY       VARCHAR2,
141                             p_transaction_type           IN               VARCHAR2,
142                             p_cal_type                   IN               VARCHAR2,
143                             p_sequence_number            IN               NUMBER,
144                             p_cal_start_dt               IN               DATE,
145                             p_cal_end_dt                 IN               DATE,
146                             p_uoo_id                     IN               NUMBER,
147                             p_unit_section_occurrence_id IN               NUMBER,
148                             p_start_time                 IN               DATE,
149                             p_end_time                   IN               DATE,
150                             p_building_id                IN               NUMBER,
151                             p_room_id                    IN               NUMBER,
152                             p_schedule_status            IN               VARCHAR2,
153                             p_error_text                 IN               VARCHAR2,
154                             p_org_id                     IN               NUMBER,
155                             p_uso_start_date             IN               DATE DEFAULT NULL,
156                             p_uso_end_date               IN               DATE DEFAULT NULL,
157                             p_sunday                     IN               VARCHAR2 DEFAULT NULL,
158                             p_monday                     IN               VARCHAR2 DEFAULT NULL,
159                             p_tuesday                    IN               VARCHAR2 DEFAULT NULL,
160                             p_wednesday                  IN               VARCHAR2 DEFAULT NULL,
161                             p_thursday                   IN               VARCHAR2 DEFAULT NULL,
162                             p_friday                     IN               VARCHAR2 DEFAULT NULL,
163                             p_saturday                   IN               VARCHAR2 DEFAULT NULL
164                             );
165 
166 -- Start of Comments
167 -- API Name               : Update_Sch
168 -- Type                   : Public
169 -- Pre-reqs               : None
170 -- Function               : Updates data in the Schedule Interface Tables
171 -- Parameters             :
172 -- IN                       p_api_version
173 -- IN                       p_init_msg_list
174 -- IN                       p_commit
175 -- IN                       p_validation_level
176 -- IN                       p_start_time
177 --                          This parameter contains the Scheduled Start Time
178 --                          of the Unit Section Occurrence
179 -- IN                       p_end_time
180 --                          This parameter contains the Scheduled End Time
181 --                          of the Unit Section Occurrence
182 -- IN                       p_building_id
183 --                          This parameter contains the Scheduled Building ID
184 --                          of the Unit Section Occurrence
185 -- IN                       p_room_id
186 --                          This parameter contains the Scheduled Room ID
187 --                          of the Unit Section Occurrence
188 -- IN                       p_schedule_status
189 --                          This parameter contains the schedule status of the
190 --                          Unit Section Occurrence
191 -- IN                       p_error_text
192 --                          This parameter contains the error text, in case of Scheduling Error of the
193 --                          Unit Section Occurrence
194 -- IN                       p_org_id
195 --                          This parameter contains the Operating Unit Identifier
196 -- IN                       p_uso_start_date
197 --                          This parameter contains unit section occurrence start date
198 -- IN                       p_uso_end_date
199 --                          This parameter contains unit section occurrence end date
200 -- IN                       p_sunday
201 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
202 --                          on sunday
203 -- IN                       p_monday
204 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
205 --                          on monday
206 -- IN                       p_tuesday
207 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
208 --                          on tuesday
209 -- IN                       p_wednesday
210 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
211 --                          on wednesday
212 -- IN                       p_thursday
213 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
214 --                          on thursday
215 -- IN                       p_friday
216 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
217 --                          on friday
218 -- IN                       p_saturday
219 --                          This parameter indicates whether a Unit Section Occurrence has been scheduled
220 --                          on saturday
221 -- OUT NOCOPY               x_return_status
222 --                          returns the status of the charges API - S if Successful,
223 --                          E if Expected Error and U if Unexpected Error
224 -- OUT NOCOPY               x_msg_count
225 -- OUT NOCOPY               x_msg_data
226 -- Version                  Current Version 1.0
227 -- End of Comments
228 
229 -- Enh bug#2833850
230 -- Added following parameters
231 -- p_uso_start_date,p_uso_end_date,p_sunday,p_monday,p_tuesday,p_wednesday,p_thursday,p_friday,p_saturday
232 /*#
233  * A public API to import(update) data into Scheduling Occurrence Interface Table.
234  * @param p_API_VERSION API Version Number
235  * @param p_INIT_MSG_LIST Initialize Message List
236  * @param p_COMMIT Commit Transaction
237  * @param p_VALIDATION_LEVEL Validation Level
238  * @param X_RETURN_STATUS Return Status
239  * @param X_MSG_COUNT Message Count
240  * @param X_MSG_DATA Message Data
241  * @param p_INT_OCCURS_ID Interface Occurrence Identifier
242  * @param p_START_TIME Start Time
243  * @param p_END_TIME End Time
244  * @param p_BUILDING_ID Building Identifier
245  * @param p_ROOM_ID Room Identifier
246  * @param p_SCHEDULE_STATUS Schedule Status
247  * @param p_ERROR_TEXT Error Text
248  * @param p_ORG_ID Operation Unit Identifier
249  * @param p_USO_START_DATE Occurrence Start Date
250  * @param p_USO_END_DATE Occurrence End Date
251  * @param p_SUNDAY Sunday
252  * @param p_MONDAY Monday
253  * @param p_TUESDAY Tuesday
254  * @param p_WEDNESDAY Wednesday
255  * @param p_THURSDAY Thursday
256  * @param p_FRIDAY Friday
257  * @param p_SATURDAY Saturday
258  * @rep:scope public
259  * @rep:lifecycle active
260  * @rep:displayname Update Schedule
261  */
262   PROCEDURE update_schedule(p_api_version             IN               NUMBER,
263                             p_init_msg_list           IN               VARCHAR2 := FND_API.G_FALSE,
264                             p_commit                  IN               VARCHAR2 := FND_API.G_FALSE,
265                             p_validation_level        IN               NUMBER := FND_API.G_VALID_LEVEL_FULL,
266                             x_return_status           OUT NOCOPY       VARCHAR2,
267                             x_msg_count               OUT NOCOPY       NUMBER,
268                             x_msg_data                OUT NOCOPY       VARCHAR2,
269                             p_int_occurs_id           IN               NUMBER,
270                             p_start_time              IN               DATE DEFAULT NULL,
271                             p_end_time                IN               DATE DEFAULT NULL,
272                             p_building_id             IN               NUMBER DEFAULT NULL,
273                             p_room_id                 IN               NUMBER DEFAULT NULL,
274                             p_schedule_status         IN               VARCHAR2,
275                             p_error_text              IN               VARCHAR2 DEFAULT NULL,
276                             p_org_id                  IN               NUMBER,
277                             p_uso_start_date          IN               DATE DEFAULT NULL,
278                             p_uso_end_date            IN               DATE DEFAULT NULL,
279                             p_sunday                  IN               VARCHAR2 DEFAULT NULL,
280                             p_monday                  IN               VARCHAR2 DEFAULT NULL,
281                             p_tuesday                 IN               VARCHAR2 DEFAULT NULL,
282                             p_wednesday               IN               VARCHAR2 DEFAULT NULL,
283                             p_thursday                IN               VARCHAR2 DEFAULT NULL,
284                             p_friday                  IN               VARCHAR2 DEFAULT NULL,
285                             p_saturday                IN               VARCHAR2 DEFAULT NULL
286                             );
287 
288 END IGS_PS_SCH_INT_API_PUB;