DBA Data[Home] [Help]

PACKAGE: APPS.AMS_EVTREGS_PUB

Source


1 PACKAGE AMS_EvtRegs_PUB AUTHID CURRENT_USER as
2 /*$Header: amspregs.pls 115.18 2003/01/28 00:46:15 dbiswas ship $*/
3 -- Start of Comments
4 -- Package name     : AMS_EvtRegs_PUB
5 -- Purpose          : Public API for Event Registrations
6 -- History          :  Created sugupta 10/16/99
7 --    12-MAR-2002    dcastlem    Added support for general Public API
8 --                               (AMS_Registrants_PUB)
9 --    27-Jan-2003    dbiswas     Modified p_block_fulfillment = 'F' bug 2769257
10 -- NOTE             :
11 -- End of Comments
12 
13 --   *******************************************************
14 --    Start of Comments
15 --   *******************************************************
16 --   API Name:  Register
17 --   Type    :  Public
18 --   Pre-Req :
19 --   Parameters:
20 --   IN
21 --       p_api_version_number      IN   NUMBER     Required
22 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
23 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
24 --       P_evt_regs_Rec     IN AMS_EVTREGS_PVT.evt_regs_Rec_Type  Required
25 --
26 --   OUT:
27 --       x_return_status           OUT  VARCHAR2
28 --       x_msg_count               OUT  NUMBER
29 --       x_event_registration_id   OUT  NUMBER
30 --       x_msg_data                OUT  VARCHAR2
31 --
32 --   End of Comments
33 --
34 PROCEDURE Register(
35     P_Api_Version_Number         IN   NUMBER,
36     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
37     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
38     P_evt_regs_Rec				 IN    AMS_EvtRegs_PVT.evt_regs_Rec_Type,
39     p_block_fulfillment          IN   VARCHAR2     := 'F',
40     x_event_registration_id      OUT NOCOPY  NUMBER,
41     x_confirmation_code			 OUT NOCOPY  VARCHAR2,
42     x_system_status_code		 OUT NOCOPY  VARCHAR2,
43     X_Return_Status              OUT NOCOPY  VARCHAR2,
44     X_Msg_Count                  OUT NOCOPY  NUMBER,
45     X_Msg_Data                   OUT NOCOPY  VARCHAR2
46 );
47 ---------------------------------------------------------------------
48 -- PROCEDURE
49 --    init_reg_rec
50 --
51 -- HISTORY
52 --    06/29/2000  sugupta  Create.
53 -- Note: Call this method to initialize the reg rec before calling Update_registration
54 ---------------------------------------------------------------------
55 PROCEDURE init_reg_rec(
56    x_evt_regs_rec  OUT NOCOPY   AMS_EvtRegs_PVT.evt_regs_Rec_Type
57 );
58 
59 --   *******************************************************
60 --    Start of Comments
61 --   *******************************************************
62 --   API Name:  Update_registration
63 --   Type    :  Public
64 --   Pre-Req :
65 --   Parameters:
66 --   IN
67 --       p_api_version_number      IN   NUMBER     Required
68 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
69 --       p_commit                  IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
70 --       P_evt_regs_Rec     IN AMS_EvtRegs_PVT.evt_regs_Rec_Type  Required
71 --
72 --   OUT:
73 --       x_return_status           OUT  VARCHAR2
74 --       x_msg_count               OUT  NUMBER
75 --       x_msg_data                OUT  VARCHAR2
76 --
77 --   End of Comments
78 --
79 PROCEDURE Update_registration(
80     P_Api_Version_Number         IN   NUMBER,
81     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
82     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
83     P_evt_regs_Rec				 IN    AMS_EvtRegs_PVT.evt_regs_Rec_Type,
84     p_block_fulfillment          IN   VARCHAR2     := 'F',
85     X_Return_Status              OUT NOCOPY  VARCHAR2,
86     X_Msg_Count                  OUT NOCOPY  NUMBER,
87     X_Msg_Data                   OUT NOCOPY  VARCHAR2
88 );
89 
90 --   *******************************************************
91 --    Start of Comments
92 --   *******************************************************
93 --   API Name:  Cancel_Registration
94 --   Type    :  Public
95 --   Pre-Req :
96 --   Parameters:
97 --   IN
98 --       p_api_version_number      IN   NUMBER     Required
99 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
100 --       p_commit            IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
101 --       p_event_offer_id     IN  NUMBER  Required
102 --       p_registration_number IN NUMBER Required
103 --       p_registration_group_id  IN NUMBER Optional
104 --   OUT:
105 --       x_return_status           OUT  VARCHAR2
106 --       x_msg_count               OUT  NUMBER
107 --       x_msg_data                OUT  VARCHAR2
108 --
109 --   modified sugupta 06/21/2000 x_cancellation_code shud be varchar2
110 --   End of Comments
111 --
112 PROCEDURE Cancel_Registration(
113     P_Api_Version_Number         IN   NUMBER,
114     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
115     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
116     p_object_version             IN   NUMBER,
117     p_event_offer_id             IN   NUMBER,
118     p_registrant_party_id	     IN   NUMBER,
119     p_confirmation_code		     IN   VARCHAR2,
120     p_registration_group_id      IN   NUMBER,
121     p_cancellation_reason_code   IN   VARCHAR2,
122     p_block_fulfillment          IN   VARCHAR2     := 'F',
123     x_cancellation_code		   OUT NOCOPY  VARCHAR2,
124     X_Return_Status              OUT NOCOPY  VARCHAR2,
125     X_Msg_Count                  OUT NOCOPY  NUMBER,
126     X_Msg_Data                   OUT NOCOPY  VARCHAR2
127 );
128 
129 PROCEDURE delete_Registration(
130     P_Api_Version_Number         IN   NUMBER,
131     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
132     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
133     p_object_version		   IN   NUMBER,
134     p_event_registration_id	   IN   NUMBER,
135 
136     X_Return_Status              OUT NOCOPY  VARCHAR2,
137     X_Msg_Count                  OUT NOCOPY  NUMBER,
138     X_Msg_Data                   OUT NOCOPY  VARCHAR2
139 );
140 -------------------------------------------------------
141 -- Start of Comments
142 --
143 -- PROCEDURE
144 --  prioritize_reg_wailist
145 --
146 -- HISTORY
147 --    11/29/99  sugupta  Added.
148 -- PURPOSE
149 --  Registrations for an event can have a wailist. This api call will look to see if it can
150 -- upgrade a reg status from wailtlisted to registered, if any cancellations or event
151 -- details have been changed.
152 -- note that cancelling a registration automatically calls this API internally to
153 -- upgrade the reg statuses in real time.
154 -------------------------------------------------------------
155 
156 PROCEDURE prioritize_reg_wailist(
157    p_api_version_number         IN   NUMBER,
158    p_Init_Msg_List              IN   VARCHAR2   := FND_API.G_FALSE,
159    P_Commit                     IN   VARCHAR2   := FND_API.G_FALSE,
160    p_event_offer_id     		IN   NUMBER,
161 
162    x_return_status              OUT NOCOPY  VARCHAR2,
163    x_msg_count                  OUT NOCOPY  NUMBER,
164    x_msg_data                   OUT NOCOPY  VARCHAR2
165 );
166 
167 -------------------------------------------------------
168 -- Start of Comments
169 --
170 -- PROCEDURE
171 --  substitute_enrollee
172 --
173 -- HISTORY
174 --    11/16/99  sugupta  Added.
175 -- PURPOSE
176 --  Substitute an enrollee(attendant) for an existing event registration..
177 -- Who can substitute is NOT verified in this API call...
178 -- If registrant information is also provided, then the existing
179 -- 'registrant information' is replaced...
180 -- 'Attendant information' is mandatory, but for account information...
181 -- if registrant info is changed, reg_contact id is stored in original_reg_contact_id column..
182 -------------------------------------------------------------
183 
184 PROCEDURE substitute_enrollee(
185     P_Api_Version_Number         IN   NUMBER,
186     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
187     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
188 
189     p_confirmation_code	         IN   VARCHAR2,	--required
190     p_attendant_party_id		 IN   NUMBER,	--required
191     p_attendant_contact_id	     IN   NUMBER,	--required
192     p_attendant_account_id       IN   NUMBER,
193     p_registrant_party_id	     IN   NUMBER,
194     p_registrant_contact_id	     IN   NUMBER,	--required
195     p_registrant_account_id	     IN   NUMBER,
196 
197     X_Return_Status              OUT NOCOPY  VARCHAR2,
198     X_Msg_Count                  OUT NOCOPY  NUMBER,
199     X_Msg_Data                   OUT NOCOPY  VARCHAR2
200 );
201 
202 -------------------------------------------------------
203 -- Start of Comments
204 --
205 -- PROCEDURE
206 --  transfer_enrollee
207 --
208 -- HISTORY
209 --    11/16/99  sugupta  Added.
210 -- PURPOSE
211 --  Transfer an enrollee(attendant) for an existing event registration
212 --  from one event offering to another offer id...
213 -- Who can transfer is NOT validated in this API call...
214 -- Waitlist flag input is mandatory which means if the other offering is full and
215 -- the attendant is willing to get waitlisted....
216 -- if the offering is full, and waitlisting is not wanted or even wailist is full, then
217 -- the transfer will fail...
218 -- PAYMENT details are not taken care of in this API call....
219 -------------------------------------------------------------
220 
221 PROCEDURE transfer_enrollee(
222     P_Api_Version_Number         IN   NUMBER,
223     P_Init_Msg_List              IN   VARCHAR2     := FND_API.G_FALSE,
224     P_Commit                     IN   VARCHAR2     := FND_API.G_FALSE,
225     p_object_version	 		 IN   NUMBER,
226     p_old_confirmation_code		 IN   VARCHAR2,	--required
227     p_old_offer_id				 IN   NUMBER,	--required
228     p_new_offer_id				 IN   NUMBER,	--required
229     p_waitlist_flag				 IN   VARCHAR2,	--required
230     p_registrant_account_id		 IN   NUMBER,  -- can be null
231     p_registrant_party_id		 IN	  NUMBER,  -- can be null
232     p_registrant_contact_id		 IN	  NUMBER,  -- can be null
233     p_attendant_party_id         IN   NUMBER,-- can be null
234     p_attendant_contact_id       IN   NUMBER,-- can be null
235     x_new_confirmation_code		 OUT NOCOPY  VARCHAR2,
236     x_old_cancellation_code		 OUT NOCOPY  VARCHAR2,
237     x_new_registration_id        OUT NOCOPY  NUMBER,
238     x_old_system_status_code	 OUT NOCOPY  VARCHAR2,
239     x_new_system_status_code     OUT NOCOPY  VARCHAR2,
240     X_Return_Status              OUT NOCOPY  VARCHAR2,
241     X_Msg_Count                  OUT NOCOPY  NUMBER,
242     X_Msg_Data                   OUT NOCOPY  VARCHAR2
243 );
244 
245 --   *******************************************************
246 --    Start of Comments
247 --   *******************************************************
248 --   API Name:  Get_Registration_details
249 --   Type    :  Public
250 --   Pre-Req :
251 --   Parameters:
252 --   IN
253 --       p_api_version_number      IN   NUMBER     Required
254 --       p_init_msg_list           IN   VARCHAR2   Optional  Default = FND_API_G_FALSE
255 --
256 --       p_return_tot_count        IN   VARCHAR2   Optional  Default = FND_API.G_FALSE
257 --       p_event_registration_id   IN   NUMBER   Required
258 --   OUT:
259 --       x_return_status           OUT  VARCHAR2
260 --       x_msg_count               OUT  NUMBER
261 --       x_msg_data                OUT  VARCHAR2
262 --       x_returned_rec_count      OUT   NUMBER
263 --       x_tot_rec_count           OUT   NUMBER
264 --
265 -- Note: will be implemented as a view......
266 --   End of Comments
267 --
268 
269 FUNCTION  GET_Reg_Rec  RETURN  AMS_EvtRegs_PVT.evt_regs_Rec_Type;
270 
271 End AMS_EvtRegs_PUB;