DBA Data[Home] [Help]

PACKAGE: APPS.CSD_GEN_ERRMSGS_PVT

Source


1 PACKAGE csd_gen_errmsgs_pvt AUTHID CURRENT_USER AS
2 /* $Header: csdvgems.pls 115.4 2004/01/11 05:43:15 vparvath noship $ */
3 
4    TYPE csd_errmsgs_rec_type IS RECORD (
5       generic_errmsgs_id   NUMBER,
6       repair_number        VARCHAR2 (30),
7       source_entity_type   VARCHAR2 (80),
8       source_entity        VARCHAR2 (80),
9       msg_type             VARCHAR2 (80),
10       msg                  VARCHAR2 (2000)
11    );
12 
13    TYPE csd_errmsgs_tbl IS TABLE OF csd_errmsgs_rec_type
14       INDEX BY BINARY_INTEGER;
15 
16 
17 /*-----------------------------------------------------------------------------------------------------------*/
18 /* procedure name:    Save_Fnd_Msgs                                                                          */
19 /* description   : This api will take the messages on the stack and save them in the generic messages table  */
20 /* Called from   : */
21 /* Input Parm    : p_api_version         NUMBER      Required Api Version number                             */
22 /*                 p_module_code         VARCHAR2    Required module which is saving the message.            */
23 /*                 p_source_entity_id_1  NUMBER      Required source entity_id 1.                            */
24 /*                                                            This is usually the repair line id.            */
25 /*                 p_source_entity_type_code VARCHAR2 Required Seeded entity type code.                      */
26 /*                                                             Valid values are 'SERIAL_NUMBER',             */
27 /*                                                             'SERVICE_CODE',                               */
28 /*                                                             'SOLUTION',                                   */
29 /*                                                             'ESTIMATE',                                   */
30 /*                                                             'TASK',                                       */
31 /*                                                             'WIP',                                        */
32 /*                 p_source_entity_id_2  NUMBER      Required source entity_id 2.                            */
33 /* Output Parm   : x_return_status       VARCHAR2             Return status after the call. The status can be*/
34 /*                                                            fnd_api.g_ret_sts_success (success)            */
35 /*                                                            fnd_api.g_ret_sts_error (error)                */
36 /*                                                            fnd_api.g_ret_sts_unexp_error (unexpected)     */
37 /*                 x_msg_count           NUMBER               Number of messages in the message stack        */
38 /*                 x_msg_data            VARCHAR2             Message text if x_msg_count >= 1               */
39 /*-----------------------------------------------------------------------------------------------------------*/
40    PROCEDURE save_fnd_msgs (
41       p_api_version               IN              NUMBER,
42       x_return_status             OUT NOCOPY      VARCHAR2,
43       x_msg_count                 OUT NOCOPY      NUMBER,
44       x_msg_data                  OUT NOCOPY      VARCHAR2,
45       p_module_code               IN              VARCHAR2,
46       p_source_entity_id1         IN              NUMBER,
47       p_source_entity_type_code   IN              VARCHAR2,
48       p_source_entity_id2         IN              NUMBER
49    );
50 
51 /*-----------------------------------------------------------------------------------------------------------*/
52 /* procedure name: Purge_Msg                                                                                 */
53 /* description   : Deletes a single generic message record                                                   */
54 /* Called from   : */
55 /* Input Parm    : p_api_version         NUMBER      Required Api Version number                             */
56 /*                 p_init_msg_list       VARCHAR2    Optional Initializes message stack if fnd_api.g_true,   */
57 /*                                                            default value is fnd_api.g_false               */
58 /*                 p_commit              VARCHAR2    Optional Commits in API if fnd_api.g_true, default      */
59 /*                                                            fnd_api.g_false                                */
60 /*                 p_validation_level    NUMBER      Optional API uses this parameter to determine which     */
61 /*                                                            validation steps must be done and which steps  */
62 /*                                                            should be skipped.                             */
63 /*                 p_generic_errmsgs_id   NUMBER      Required  KEy field for the messages table             */
64 /* Output Parm   : x_return_status       VARCHAR2             Return status after the call. The status can be*/
65 /*                                                            fnd_api.g_ret_sts_success (success)            */
66 /*                                                            fnd_api.g_ret_sts_error (error)                */
67 /*                                                            fnd_api.g_ret_sts_unexp_error (unexpected)     */
68 /*                 x_msg_count           NUMBER               Number of messages in the message stack        */
69 /*                 x_msg_data            VARCHAR2             Message text if x_msg_count >= 1               */
70 /*-----------------------------------------------------------------------------------------------------------*/
71    PROCEDURE purge_msg (
72       p_api_version          IN              NUMBER,
73       x_return_status        OUT NOCOPY      VARCHAR2,
74       x_msg_count            OUT NOCOPY      NUMBER,
75       x_msg_data             OUT NOCOPY      VARCHAR2,
76       p_generic_errmsgs_id   IN              NUMBER
77    );
78 
79 /*-----------------------------------------------------------------------------------------------------------*/
80 /* procedure name: PURGE_ENTITY_MSGS                                                                         */
81 /* description   : This API will delete the messages for the given module,entity codes                       */
82 /* Called from   : */
83 /* Input Parm    : p_api_version         NUMBER      Required Api Version number                             */
84 /*                 p_init_msg_list       VARCHAR2    Optional Initializes message stack if fnd_api.g_true,   */
85 /*                                                            default value is fnd_api.g_false               */
86 /*                 p_commit              VARCHAR2    Optional Commits in API if fnd_api.g_true, default      */
87 /*                                                            fnd_api.g_false                                */
88 /*                 p_validation_level    NUMBER      Optional API uses this parameter to determine which     */
89 /*                                                            validation steps must be done and which steps  */
90 /*                                                            should be skipped.                             */
91 /*                 p_module_code         VARCHAR2    Required module which is saving the message.            */
92 /*                 p_source_entity_id_1  NUMBER      optional source entity_id 1.                            */
93 /*                                                            This is usually the repair line id.            */
94 /*                 p_source_entity_type_code VARCHAR2 Optional Seeded entity type code.                      */
95 /*                                                             Valid values are 'SERIAL_NUMBER',             */
96 /*                                                             'SERVICE_CODE',                               */
97 /*                                                             'SOLUTION',                                   */
98 /*                                                             'ESTIMATE',                                   */
99 /*                                                             'TASK',                                       */
100 /*                                                             'WIP',                                        */
101 /*                 p_source_entity_id_2  NUMBER      Optional source entity_id 2.                            */
102 /* Output Parm   : x_return_status       VARCHAR2             Return status after the call. The status can be*/
103 /*                                                            fnd_api.g_ret_sts_success (success)            */
104 /*                                                            fnd_api.g_ret_sts_error (error)                */
105 /*                                                            fnd_api.g_ret_sts_unexp_error (unexpected)     */
106 /*                 x_msg_count           NUMBER               Number of messages in the message stack        */
107 /*                 x_msg_data            VARCHAR2             Message text if x_msg_count >= 1               */
108 /*-----------------------------------------------------------------------------------------------------------*/
109    PROCEDURE purge_entity_msgs (
110       p_api_version               IN              NUMBER,
111       x_return_status             OUT NOCOPY      VARCHAR2,
112       x_msg_count                 OUT NOCOPY      NUMBER,
113       x_msg_data                  OUT NOCOPY      VARCHAR2,
114       p_module_code               IN              VARCHAR2,
115       p_source_entity_id1         IN              NUMBER,
116       p_source_entity_type_code   IN              VARCHAR2,
117       p_source_entity_id2         IN              NUMBER
118    );
119 
120 /*-----------------------------------------------------------------------------------------------------------*/
121 /* procedure name: GET_ERRMSGS                                                                               */
122 /* description   : This API will retrieve the messages from the table, populates the message data structure */
123 /*                 and returns the messages data structures.
124 /* Called from   : */
125 /* Input Parm    : p_api_version         NUMBER      Required Api Version number                             */
126 /*                 p_init_msg_list       VARCHAR2    Optional Initializes message stack if fnd_api.g_true,   */
127 /*                                                            default value is fnd_api.g_false               */
128 /*                 p_commit              VARCHAR2    Optional Commits in API if fnd_api.g_true, default      */
129 /*                                                            fnd_api.g_false                                */
130 /*                 p_validation_level    NUMBER      Optional API uses this parameter to determine which     */
131 /*                                                            validation steps must be done and which steps  */
132 /*                                                            should be skipped.                             */
133 /*                 p_module_code         VARCHAR2    Required module which is saving the message.            */
134 /*                 p_source_entity_id_1  NUMBER      optional source entity_id 1.                            */
135 /*                                                            This is usually the repair line id.            */
136 /*                 p_source_entity_type_code VARCHAR2 Optional Seeded entity type code.                      */
137 /*                                                             Valid values are 'SERIAL_NUMBER',             */
138 /*                                                             'SERVICE_CODE',                               */
139 /*                                                             'SOLUTION',                                   */
140 /*                                                             'ESTIMATE',                                   */
141 /*                                                             'TASK',                                       */
142 /*                                                             'WIP',                                        */
143 /*                 p_source_entity_id_2  NUMBER      Optional source entity_id 2.                            */
144 /* Output Parm   : x_errmsgs_tbl         CSD_ERRMSGS_TBL       table of message records                      */
145 /*                 x_return_status       VARCHAR2             Return status after the call. The status can be*/
146 /*                                                            fnd_api.g_ret_sts_success (success)            */
147 /*                                                            fnd_api.g_ret_sts_error (error)                */
148 /*                                                            fnd_api.g_ret_sts_unexp_error (unexpected)     */
149 /*                 x_msg_count           NUMBER               Number of messages in the message stack        */
150 /*                 x_msg_data            VARCHAR2             Message text if x_msg_count >= 1               */
151 /*-----------------------------------------------------------------------------------------------------------*/
152    PROCEDURE get_errmsgs (
153       p_api_version               IN              NUMBER,
154       p_init_msg_list             IN              VARCHAR2,
155       x_return_status             OUT NOCOPY      VARCHAR2,
156       x_msg_count                 OUT NOCOPY      NUMBER,
157       x_msg_data                  OUT NOCOPY      VARCHAR2,
158       p_module_code               IN              VARCHAR2,
159       p_source_entity_id_1        IN              NUMBER,
160       p_source_entity_type_code   IN              VARCHAR2,
161       p_source_entity_id_2        IN              NUMBER,
162       x_errmsgs_tbl               OUT NOCOPY      csd_errmsgs_tbl
163    );
164 
165 /*-----------------------------------------------------------------------------------------------------------*/
166 /* procedure name: PURGE_ENTITY_MSGS_CP                                                                        */
167 /* description   : This API will delete the messages for the given module,entity codes                       */
168 /* Called from   : */
169 /* Input Parm    : p_module_code         VARCHAR2    Required module which is saving the message.            */
170 /*                 p_source_entity_id_1  NUMBER      optional source entity_id 1.                            */
171 /*                                                            This is usually the repair line id.            */
172 /*                 p_source_entity_type_code VARCHAR2 Optional Seeded entity type code.                      */
173 /*                                                             Valid values are 'SERIAL_NUMBER',             */
174 /*                                                             'SERVICE_CODE',                               */
175 /*                                                             'SOLUTION',                                   */
176 /*                                                             'ESTIMATE',                                   */
177 /*                                                             'TASK',                                       */
178 /*                                                             'WIP',                                        */
179 /*                 p_source_entity_id_2  NUMBER      Optional source entity_id 2.                            */
180 /* Output Parm   : errbuf       VARCHAR2             Return status after the call. The status can be*/
181 /*                                                            fnd_api.g_ret_sts_success (success)            */
182 /*                                                            fnd_api.g_ret_sts_error (error)                */
183 /*                                                            fnd_api.g_ret_sts_unexp_error (unexpected)     */
184 /*                 retcode      NUMBER               Number of messages in the message stack        */
185 /*-----------------------------------------------------------------------------------------------------------*/
186    PROCEDURE purge_entity_msgs_cp (
187       errbuf          OUT NOCOPY      VARCHAR2,
188       retcode         OUT NOCOPY      NUMBER,
189       p_module_code   IN              VARCHAR2
190    );
191 
192 
193 ---------------------Temporary
194    PROCEDURE save_fnd_msgs (
195       p_api_version               IN              NUMBER,
196       p_commit                 IN              VARCHAR2,
197       p_init_msg_list          IN              VARCHAR2,
198       p_validation_level       IN              NUMBER,
199       x_return_status             OUT NOCOPY      VARCHAR2,
200       x_msg_count                 OUT NOCOPY      NUMBER,
201       x_msg_data                  OUT NOCOPY      VARCHAR2,
202       p_module_code               IN              VARCHAR2,
203       p_source_entity_id1         IN              NUMBER,
204       p_source_entity_type_code   IN              VARCHAR2,
205       p_source_entity_id2         IN              NUMBER
206    );
207 
208 
209    PROCEDURE purge_entity_msgs (
213       p_validation_level       IN              NUMBER,
210       p_api_version               IN              NUMBER,
211       p_commit                 IN              VARCHAR2,
212       p_init_msg_list          IN              VARCHAR2,
214       x_return_status             OUT NOCOPY      VARCHAR2,
215       x_msg_count                 OUT NOCOPY      NUMBER,
216       x_msg_data                  OUT NOCOPY      VARCHAR2,
217       p_module_code               IN              VARCHAR2,
218       p_source_entity_id1         IN              NUMBER,
222 
219       p_source_entity_type_code   IN              VARCHAR2,
220       p_source_entity_id2         IN              NUMBER
221    );
223 
224 END csd_gen_errmsgs_pvt;