1 PACKAGE AMS_ListAction_PVT AUTHID CURRENT_USER as
2 /* $Header: amsvlsas.pls 115.13 2002/11/22 08:55:49 jieli ship $ */
3 -- Start of Comments
4 --
5 -- PACKAGE
6 -- AMS_ListAction_PVT
7
8 -- Procedures:
9
10 -- Create_ListAction
11 -- Update_ListAction
12 -- Delete_ListAction
13 -- Lock_ListAction
14 -- Validate_ListAction
15 -- Init_action_rec
16 -- Complete_action_rec
17
18
19 -- HISTORY
20 -- 01/22/2001 vbhandar created
21 -- 02/19/2001 sveerave included no_of_rows_targeted in action_rec_type
22 -- End of Comments
23
24 TYPE action_rec_type IS RECORD(
25 LIST_SELECT_ACTION_ID NUMBER
26 ,LAST_UPDATE_DATE DATE
27 ,LAST_UPDATED_BY NUMBER
28 ,CREATION_DATE DATE
29 ,CREATED_BY NUMBER
30 ,LAST_UPDATE_LOGIN NUMBER
31 ,OBJECT_VERSION_NUMBER NUMBER
32 -- ,LIST_HEADER_ID NUMBER
33 ,ORDER_NUMBER NUMBER
34 ,LIST_ACTION_TYPE VARCHAR2(30)
35 -- ,INCL_OBJECT_NAME VARCHAR2(254)
36 ,ARC_INCL_OBJECT_FROM VARCHAR2(30)
37 ,INCL_OBJECT_ID NUMBER
38 -- ,INCL_OBJECT_WB_SHEET VARCHAR2(254)
39 -- ,INCL_OBJECT_WB_OWNER NUMBER
40 -- ,INCL_OBJECT_CELL_CODE VARCHAR2(30)
41 ,RANK NUMBER
42 ,NO_OF_ROWS_AVAILABLE NUMBER
43 ,NO_OF_ROWS_REQUESTED NUMBER
44 ,NO_OF_ROWS_USED NUMBER
45 ,DISTRIBUTION_PCT NUMBER
46 ,RESULT_TEXT VARCHAR2(4000)
47 ,DESCRIPTION VARCHAR2(4000)
48 ,ARC_ACTION_USED_BY VARCHAR2(30)
49 ,ACTION_USED_BY_ID NUMBER
50 ,NO_OF_ROWS_TARGETED NUMBER
51 ,incl_control_group varchar2(1)
52 );
53
54
55
56 ---------------------------------------------------------------------
57 -- PROCEDURE
58 -- Create_ListAction
59 --
60 -- PURPOSE
61 -- Create a new List Select Action.
62 --
63 -- PARAMETERS
64 -- p_action_rec: the new record to be inserted
65 -- x_action_id: return the campaign_id of the new campaign
66 --
67 -- NOTES
68 -- 1. object_version_number will be set to 1.
69 -- 2. If action_id is passed in, the uniqueness will be checked.
70 -- Raise exception in case of duplicates.
71 -- 3. If action_id is not passed in, generate a unique one from
72 -- the sequence.
73 -- 4. If a flag column is passed in, check if it is 'Y' or 'N'.
74 -- Raise exception for invalid flag.
75 -- 5. If a flag column is not passed in, default it to 'Y' or 'N'.
76 -- 6. Please don't pass in any FND_API.g_mess_char/num/date.
77 -- 7. Since it is a generic api check whether valid arc_action_used_by
78 -- is passed
79 ---------------------------------------------------------------------
80 PROCEDURE Create_ListAction
81 ( p_api_version IN NUMBER,
82 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
83 p_commit IN VARCHAR2 := FND_API.G_FALSE,
84 p_validation_level IN NUMBER
85 := FND_API.G_VALID_LEVEL_FULL,
86 x_return_status OUT NOCOPY VARCHAR2,
87 x_msg_count OUT NOCOPY NUMBER,
88 x_msg_data OUT NOCOPY VARCHAR2,
89
90 p_action_rec IN action_rec_type,
91 x_action_id OUT NOCOPY NUMBER
92 ) ;
93
94 ---------------------------------------------------------------------
95 -- PROCEDURE
96 -- Update_ListAction
97 --
98 -- PURPOSE
99 -- Update a List Action.
100 --
101 -- PARAMETERS
102 -- p_action_rec: the record with new items
103 --
104 -- NOTES
105 -- 1. Raise exception if the object_version_number doesn't match.
106 -- 2. If an attribute is passed in as FND_API.g_miss_char/num/date,
107 -- that column won't be updated.
108 ----------------------------------------------------------------------
109 -- End Of Comments
110 PROCEDURE Update_ListAction
111 ( p_api_version IN NUMBER,
112 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
113 p_commit IN VARCHAR2 := FND_API.G_FALSE,
114 p_validation_level IN NUMBER
115 := FND_API.G_VALID_LEVEL_FULL,
116 x_return_status OUT NOCOPY VARCHAR2,
117 x_msg_count OUT NOCOPY NUMBER,
118 x_msg_data OUT NOCOPY VARCHAR2,
119
120 p_action_rec IN action_rec_type
121 );
122
123 -- Start of Comments
124 --------------------------------------------------------------------
125 -- PROCEDURE
126 -- Delete_ListAction
127 --
128 -- PURPOSE
129 -- Delete a List Action.
130 --
131 -- PARAMETERS
132 -- p_action_id: the action_id
133 -- p_object_version: the object_version_number
134 --
135 -- NOTES
136 -- 1. Raise exception if the object_version_number doesn't match.
137 --------------------------------------------------------------------
138 -- End Of Comments
139 PROCEDURE Delete_ListAction
140 ( p_api_version IN NUMBER,
141 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
142 p_commit IN VARCHAR2 := FND_API.G_FALSE,
143 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
144
145 x_return_status OUT NOCOPY VARCHAR2,
146 x_msg_count OUT NOCOPY NUMBER,
147 x_msg_data OUT NOCOPY VARCHAR2,
148
149 p_action_id IN NUMBER
150 );
151
152 -- Start of Comments
153 -------------------------------------------------------------------
154 -- PROCEDURE
155 -- Lock_ListAction
156 --
157 -- PURPOSE
158 -- Lock a List Action.
159 --
160 -- PARAMETERS
161 -- p_action_id: the action_id
162 -- p_object_version: the object_version_number
163 --
164 -- NOTES
165 -- 1. Raise exception if the object_version_number doesn't match.
166 --------------------------------------------------------------------
167 -- End Of Comments
168 PROCEDURE Lock_ListAction
169 ( p_api_version IN NUMBER,
170 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
171 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
172
173 x_return_status OUT NOCOPY VARCHAR2,
174 x_msg_count OUT NOCOPY NUMBER,
175 x_msg_data OUT NOCOPY VARCHAR2,
176
177 p_action_id IN NUMBER,
178 p_object_version IN NUMBER
179 );
180
181
182 -- Start of Comments
183 ---------------------------------------------------------------------
184 -- PROCEDURE
185 -- Validate_ListAction
186 --
187 -- PURPOSE
188 -- Validate a List Action.
189 --
190 -- PARAMETERS
191 -- p_action_rec: the list action record to be validated
192 --
193 -- NOTES
194 -- 1. p_action_rec should be the complete list action record. There
195 -- should not be any FND_API.g_miss_char/num/date in it.
196 ----------------------------------------------------------------------
197 -- End Of Comments
198 PROCEDURE Validate_ListAction
199 ( p_api_version IN NUMBER,
200 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
201 p_validation_level IN NUMBER
202 := FND_API.G_VALID_LEVEL_FULL,
203 x_return_status OUT NOCOPY VARCHAR2,
204 x_msg_count OUT NOCOPY NUMBER,
205 x_msg_data OUT NOCOPY VARCHAR2,
206
207 p_action_rec IN action_rec_type
208 );
209
210 ---------------------------------------------------------------------
211 -- PROCEDURE
212 -- init_action_rec
213 --
214 -- PURPOSE
215 -- Initialize all attributes to be FND_API.g_miss_char/num/date.
216 ---------------------------------------------------------------------
217 PROCEDURE init_action_rec(
218 x_action_rec OUT NOCOPY action_rec_type
219 );
220
221
222 ---------------------------------------------------------------------
223 -- PROCEDURE
224 -- complete_action_rec
225 --
226 -- PURPOSE
227 -- For update_action, some attributes may be passed in as
228 -- FND_API.g_miss_char/num/date if the user doesn't want to
229 -- update those attributes. This procedure will replace the
230 -- "g_miss" attributes with current database values.
231 --
232 -- PARAMETERS
233 -- p_action_rec: the record which may contain attributes as
234 -- FND_API.g_miss_char/num/date
235 -- x_complete_rec: the complete record after all "g_miss" items
236 -- have been replaced by current database values
237 ---------------------------------------------------------------------
238 PROCEDURE complete_action_rec(
239 p_action_rec IN action_rec_type,
240 x_complete_rec OUT NOCOPY action_rec_type
241 );
242
243 END AMS_ListAction_PVT;
[Home] [Help]