DBA Data[Home] [Help]

PACKAGE: APPS.AMS_MESSAGES_PVT

Source


1 PACKAGE AMS_Messages_PVT AUTHID CURRENT_USER AS
2 /* $Header: amsvmsgs.pls 115.12 2002/11/15 21:02:34 abhola ship $ */
3 
4 TYPE msg_rec_type IS RECORD
5 (
6   MESSAGE_ID               NUMBER,
7   LAST_UPDATE_DATE         DATE,
8   LAST_UPDATED_BY          NUMBER,
9   CREATION_DATE            DATE,
10   CREATED_BY               NUMBER,
11   LAST_UPDATE_LOGIN        NUMBER,
12   OBJECT_VERSION_NUMBER    NUMBER,
13   DATE_EFFECTIVE_FROM      DATE,
14   DATE_EFFECTIVE_TO        DATE,
15   ACTIVE_FLAG              VARCHAR2(1),
16   MESSAGE_TYPE_CODE        VARCHAR2(30),
17   OWNER_USER_ID            NUMBER,
18   MESSAGE_NAME             VARCHAR2(120),
19   DESCRIPTION              VARCHAR2(4000),
20   COUNTRY_ID               NUMBER,
21   attribute_category            VARCHAR2(30),
22   attribute1                    VARCHAR2(150),
23   attribute2                    VARCHAR2(150),
24   attribute3                    VARCHAR2(150),
25   attribute4                    VARCHAR2(150),
26   attribute5                    VARCHAR2(150),
27   attribute6                    VARCHAR2(150),
28   attribute7                    VARCHAR2(150),
29   attribute8                    VARCHAR2(150),
30   attribute9                    VARCHAR2(150),
31   attribute10                   VARCHAR2(150),
32   attribute11                   VARCHAR2(150),
33   attribute12                   VARCHAR2(150),
34   attribute13                   VARCHAR2(150),
35   attribute14                   VARCHAR2(150),
36   attribute15                   VARCHAR2(150)
37 );
38 
39 
40 /****************************************************************************/
41 -- Procedure
42 --   create_message
43 -- Purpose
44 --   create a row in AMS_MESSAGES_B and AMS_MESSAGES_TL
45 -- Parameters
46 --   IN:
47 --     p_api_version         IN      NUMBER
48 --     p_init_msg_list       IN      VARCHAR2 := FND_API.g_false
49 --     p_commit              IN      VARCHAR2 := FND_API.g_false
50 --     p_validation_level    IN      NUMBER   := FND_API.g_valid_level_full
51 --
52 --     p_msg_rec             IN      msg_rec_type
53 --
54 --   OUT:
55 --     x_return_status       OUT     VARCHAR2
56 --     x_msg_count           OUT     NUMBER
57 --     x_msg_data            OUT     VARCHAR2
58 --
59 --     x_msg_id         OUT     NUMBER
60 ------------------------------------------------------------------------------
61 PROCEDURE create_msg
62 (
63   p_api_version         IN      NUMBER,
64   p_init_msg_list       IN      VARCHAR2 := FND_API.g_false,
65   p_commit              IN      VARCHAR2 := FND_API.g_false,
66   p_validation_level    IN      NUMBER   := FND_API.g_valid_level_full,
67 
68   x_return_status       OUT NOCOPY     VARCHAR2,
69   x_msg_count           OUT NOCOPY     NUMBER,
70   x_msg_data            OUT NOCOPY     VARCHAR2,
71 
72   p_msg_rec             IN      msg_rec_type,
73   x_msg_id              OUT NOCOPY     NUMBER
74 );
75 
76 /****************************************************************************/
77 -- Procedure
78 --   update_msg
79 -- Purpose
80 --   update a row in AMS_MESSAGES_B and AMS_MESSAGES_TL
81 -- Parameters
82 --   IN:
83 --     p_api_version         IN      NUMBER
84 --     p_init_msg_list       IN      VARCHAR2 := FND_API.g_false
85 --     p_commit              IN      VARCHAR2 := FND_API.g_false
86 --     p_validation_level    IN      NUMBER   := FND_API.g_valid_level_full
87 --
88 --     p_msg_rec             IN      msg_rec_type
89 --
90 --   OUT:
91 --     x_return_status      OUT      VARCHAR2
92 --     x_msg_count          OUT      NUMBER
93 --     x_msg_data           OUT      VARCHAR2
94 ------------------------------------------------------------------------------
95 PROCEDURE update_msg
96 (
97   p_api_version         IN      NUMBER,
98   p_init_msg_list       IN      VARCHAR2 := FND_API.g_false,
99   p_commit              IN      VARCHAR2 := FND_API.g_false,
100   p_validation_level    IN      NUMBER   := FND_API.g_valid_level_full,
101 
102   x_return_status       OUT NOCOPY     VARCHAR2,
103   x_msg_count           OUT NOCOPY     NUMBER,
104   x_msg_data            OUT NOCOPY     VARCHAR2,
105 
106   p_msg_rec             IN      msg_rec_type
107 );
108 
109 /****************************************************************************/
110 -- Procedure
111 --   delete_msg
112 -- Purpose
113 --   delete a row from AMS_MESSAGES_B and AMS_MESSAGES_TL
114 -- Parameters
115 --   IN:
116 --     p_api_version       IN      NUMBER
117 --     p_init_msg_list     IN      VARCHAR2 := FND_API.g_false
118 --     p_commit            IN      VARCHAR2 := FND_API.g_false
119 --
120 --     p_msg_id            IN      NUMBER
121 --     p_object_version    IN      NUMBER
122 --
123 --   OUT:
124 --     x_return_status     OUT     VARCHAR2
125 --     x_msg_count         OUT     NUMBER
126 --     x_msg_data          OUT     VARCHAR2
127 ------------------------------------------------------------------------------
128 PROCEDURE delete_msg
129 (
130   p_api_version       IN      NUMBER,
131   p_init_msg_list     IN      VARCHAR2 := FND_API.g_false,
132   p_commit            IN      VARCHAR2 := FND_API.g_false,
133 
134   x_return_status     OUT NOCOPY     VARCHAR2,
135   x_msg_count         OUT NOCOPY     NUMBER,
136   x_msg_data          OUT NOCOPY     VARCHAR2,
137 
138   p_msg_id            IN      NUMBER,
139   p_object_version    IN      NUMBER
140 );
141 
142 /****************************************************************************/
143 -- Procedure
144 --   lock_msg
145 -- Purpose
146 --   lock a row form AMS_MESSAGES_B and AMS_MESSAGES_TL
147 -- Parameters
148 --   IN:
149 --     p_api_version         IN      NUMBER
150 --     p_init_msg_list       IN      VARCHAR2 := FND_API.g_false
151 --
152 --     p_msg_id         IN      NUMBER
153 --     p_object_version      IN      NUMBER
154 --
155 --   OUT:
156 --     x_return_status       OUT     VARCHAR2
157 --     x_msg_count           OUT     NUMBER
158 --     x_msg_data            OUT     VARCHAR2
159 ------------------------------------------------------------------------------
160 PROCEDURE lock_msg
161 (
162   p_api_version       IN      NUMBER,
163   p_init_msg_list     IN      VARCHAR2 := FND_API.g_false,
164 
165   x_return_status     OUT NOCOPY     VARCHAR2,
166   x_msg_count         OUT NOCOPY     NUMBER,
167   x_msg_data          OUT NOCOPY     VARCHAR2,
168 
169   p_msg_id            IN      NUMBER,
170   p_object_version    IN      NUMBER
171 );
172 
173 /***************************************************************************/
174 -- Procedure
175 --   validate_msg
176 -- Purpose
177 --   validate a record before inserting or updating
178 --   AMS_MESSAGES_B and AMS_MESSAGES_TL
179 -- Parameters
180 --   IN:
181 --     p_api_version         IN      NUMBER
182 --     p_init_msg_list       IN      VARCHAR2 := FND_API.g_false
183 --     p_validation_level    IN      NUMBER := FND_API.g_valid_level_full
184 --
185 --     p_msg_rec             IN      msg_rec_type
186 --
187 --   OUT:
188 --     x_return_status       OUT     VARCHAR2
189 --     x_msg_count           OUT     NUMBER
190 --     x_msg_data            OUT     VARCHAR2
191 ------------------------------------------------------------------------------
192 PROCEDURE validate_msg
193 (
194   p_api_version         IN      NUMBER,
195   p_init_msg_list       IN      VARCHAR2 := FND_API.g_false,
196   p_validation_level    IN      NUMBER := FND_API.g_valid_level_full,
197 
198   x_return_status       OUT NOCOPY     VARCHAR2,
199   x_msg_count           OUT NOCOPY     NUMBER,
200   x_msg_data            OUT NOCOPY     VARCHAR2,
201 
202   p_msg_rec             IN      msg_rec_type
203 );
204 
205 /****************************************************************************/
206 -- Procedure
207 --   check_items
208 -- Purpose
209 --   item_level validate
210 -- Parameters
211 --   IN:
212 --     p_validation_mode    IN      VARCHAR2
213 --     p_msg_rec            IN      msg_rec_type
214 --   OUT:
215 --     x_return_status      OUT     VARCHAR2
216 ------------------------------------------------------------------------------
217 PROCEDURE check_items
218 (
219     p_validation_mode    IN      VARCHAR2,
220     x_return_status      OUT NOCOPY     VARCHAR2,
221     p_msg_rec            IN      msg_rec_type
222 );
223 
224 /****************************************************************************/
225 -- Procedure
226 --   check_req_items
227 -- Purpose
228 --   check if required items are missing
229 -- Parameters
230 --   IN:
231 --     p_validation_mode    IN      VARCHAR2
232 --     p_msg_rec            IN      msg_rec_type
233 --   OUT:
234 --     x_return_status      OUT     VARCHAR2
235 ------------------------------------------------------------------------------
236 PROCEDURE check_req_items
237 (
238   p_validation_mode    IN      VARCHAR2,
239   p_msg_rec       IN      msg_rec_type,
240   x_return_status      OUT NOCOPY     VARCHAR2
241 );
242 
243 /****************************************************************************/
244 -- Procedure
245 --   check_uk_items
246 -- Purpose
247 --   check unique key items
248 -- Parameters
249 --   IN:
250 --     p_validation_mode    IN      VARCHAR2
251 --     p_msg_rec            IN      msg_rec_type
252 --   OUT:
253 --     x_return_status      OUT     VARCHAR2
254 ------------------------------------------------------------------------------
255 PROCEDURE check_uk_items
256 (
257   p_validation_mode    IN      VARCHAR2 := JTF_PLSQL_API.g_create,
258   p_msg_rec            IN      msg_rec_type,
259   x_return_status      OUT NOCOPY     VARCHAR2
260 );
261 
262 /*****************************************************************************/
263 -- Procedure
264 --    check_record
265 -- Purpose
266 --   record level check
267 -- Parameters
268 --   IN:
269 --     p_msg_rec         IN      msg_rec_type
270 --     p_complete_rec    IN      msg_rec_type
271 --   OUT:
272 --     x_return_status   OUT     VARCHAR2
273 -- HISTORY
274 -------------------------------------------------------------------------------
275 PROCEDURE check_record
276 (
277   p_msg_rec         IN  msg_rec_type,
278   p_complete_rec    IN  msg_rec_type,
279   x_return_status   OUT NOCOPY VARCHAR2
280 );
281 
282 /****************************************************************************/
283 -- Procedure
284 --   complete_rec
285 -- Purpose
286 --   replace "g_miss" values with current database values
287 -- Parameters
288 --   IN:
289 --     p_msg_rec         IN      msg_rec_type
290 --   OUT:
291 --     x_complete_rec    OUT     msg_rec_type
292 ------------------------------------------------------------------------------
293 PROCEDURE complete_msg_rec
294 (
295   p_msg_rec         IN      msg_rec_type,
296   x_complete_rec    OUT NOCOPY     msg_rec_type
297 );
298 
299 /****************************************************************************/
300 -- Procedure
301 --   init_rec
302 --
303 -- HISTORY
304 --    12/19/1999    julou    Created.
305 ------------------------------------------------------------------------------
306 PROCEDURE init_rec
307 (
308   x_msg_rec  OUT NOCOPY  msg_rec_type
309 );
310 
311 END AMS_Messages_PVT;