[Home] [Help]
PACKAGE: APPS.AMS_LISTFIELD_PVT
Source
1 PACKAGE AMS_ListField_PVT AUTHID CURRENT_USER AS
2 /* $Header: amsvlfds.pls 115.1 2000/02/05 17:49:01 pkm ship $ */
3
4 -----------------------------------------------------------
5 -- PACKAGE
6 -- AMS_ListField_PVT
7 --
8 -- PURPOSE
9 -- Private API for Oracle Marketing List Fields.
10 --
11 -- PROCEDURES
12 -- Lock_ListField
13 -- Update_ListField
14 -- Validate_ListField
15 --
16 -- Check_ListField_Items
17 -- Check_ListField_Record
18 --
19 -- Init_ListField_Rec
20 -- Complete_ListField_Rec
21 ------------------------------------------------------------
22
23 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AMS_ListField_PVT';
24
25 TYPE List_Field_Rec_Type IS RECORD (
26 list_field_id NUMBER,
27 last_update_date DATE,
28 last_updated_by NUMBER,
29 creation_date DATE,
30 created_by NUMBER,
31 last_update_login NUMBER,
32 object_version_number NUMBER,
33 field_table_name VARCHAR2(30),
34 field_column_name VARCHAR2(30),
35 column_data_type VARCHAR2(30),
36 column_data_length NUMBER,
37 enabled_flag VARCHAR2(1),
38 list_type_field_apply_on VARCHAR2(30),
39 description VARCHAR2(4000)
40 );
41
42 --------------------------------------------------------------------
43 -- PROCEDURE
44 -- Lock_ListField
45 --
46 -- PURPOSE
47 -- Lock a list field entry.
48 --
49 -- PARAMETERS
50 -- p_listfield_id: the list_field_id
51 -- p_object_version: the object_version_number
52 --
53 -- ISSUES
54 --
55 -- NOTES
56 -- 1. Raise exception if the object_version_number doesn't match.
57 --------------------------------------------------------------------
58 PROCEDURE Lock_ListField (
59 p_api_version IN NUMBER,
60 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
61 p_commit IN VARCHAR2 := FND_API.g_false,
62 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
63
64 x_return_status OUT VARCHAR2,
65 x_msg_count OUT NUMBER,
66 x_msg_data OUT VARCHAR2,
67
68 p_listfield_id IN NUMBER,
69 p_object_version IN NUMBER
70 );
71
72
73 --------------------------------------------------------------------
74 -- PROCEDURE
75 -- Update_ListField
76 --
77 -- PURPOSE
78 -- Update a list field entry.
79 --
80 -- PARAMETERS
81 -- p_listfield_rec: the record representing AMS_LIST_FIELDS_VL.
82 --
83 -- NOTES
84 -- 1. Raise exception if the object_version_number doesn't match.
85 -- 2. If an attribute is passed in as FND_API.g_miss_char/num/date,
86 -- that column won't be updated.
87 --------------------------------------------------------------------
88 PROCEDURE Update_ListField (
89 p_api_version IN NUMBER,
90 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
91 p_commit IN VARCHAR2 := FND_API.g_false,
92 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
93
94 x_return_status OUT VARCHAR2,
95 x_msg_count OUT NUMBER,
96 x_msg_data OUT VARCHAR2,
97
98 p_listfield_rec IN List_Field_Rec_Type
99 );
100
101
102 --------------------------------------------------------------------
103 -- PROCEDURE
104 -- Validate_ListField
105 --
106 -- PURPOSE
107 -- Validate a list field entry.
108 --
109 -- PARAMETERS
110 -- p_listfield_rec: the record representing AMS_LIST_FIELDS_VL.
111 --
112 -- NOTES
113 -- 1. p_listfield_rec should be the complete list header record. There
114 -- should not be any FND_API.g_miss_char/num/date in it.
115 -- 2. If FND_API.g_miss_char/num/date is in the record, then raise
116 -- an exception, as those values are not handled.
117 --------------------------------------------------------------------
118 PROCEDURE Validate_ListField (
119 p_api_version IN NUMBER,
120 p_init_msg_list IN VARCHAR2 := FND_API.g_false,
121 p_commit IN VARCHAR2 := FND_API.g_false,
122 p_validation_level IN NUMBER := FND_API.g_valid_level_full,
123
124 x_return_status OUT VARCHAR2,
125 x_msg_count OUT NUMBER,
126 x_msg_data OUT VARCHAR2,
127
128 p_listfield_rec IN List_Field_Rec_Type
129 );
130
131
132 ---------------------------------------------------------------------
133 -- PROCEDURE
134 -- Check_ListField_Items
135 --
136 -- PURPOSE
137 -- Perform the item level checking including unique keys,
138 -- required columns, foreign keys, domain constraints.
139 --
140 -- PARAMETERS
141 -- p_listfield_rec: the record to be validated
142 -- p_validation_mode: JTF_PLSQL_API.g_create/g_update
143 ---------------------------------------------------------------------
144 PROCEDURE Check_ListField_Items (
145 p_listfield_rec IN List_Field_Rec_Type,
146 p_validation_mode IN VARCHAR2 := JTF_PLSQL_API.g_create,
147 x_return_status OUT VARCHAR2
148 );
149
150
151 ---------------------------------------------------------------------
152 -- PROCEDURE
153 -- Check_ListField_Record
154 --
155 -- PURPOSE
156 -- Check the record level business rules.
157 --
158 -- PARAMETERS
159 -- p_listfield_rec: the record to be validated; may contain attributes
160 -- as FND_API.g_miss_char/num/date
161 -- p_complete_rec: the complete record after all "g_miss" items
162 -- have been replaced by current database values
163 ---------------------------------------------------------------------
164 PROCEDURE Check_ListField_Record (
165 p_listfield_rec IN List_Field_Rec_Type,
166 p_complete_rec IN List_Field_Rec_Type := NULL,
167 x_return_status OUT VARCHAR2
168 );
169
170
171 ---------------------------------------------------------------------
172 -- PROCEDURE
173 -- Init_ListField_Rec
174 --
175 -- PURPOSE
176 -- Initialize all attributes to be FND_API.g_miss_char/num/date.
177 ---------------------------------------------------------------------
178 PROCEDURE Init_ListField_Rec (
179 x_listfield_rec OUT List_Field_Rec_Type
180 );
181
182
183 ---------------------------------------------------------------------
184 -- PROCEDURE
185 -- Complete_ListField_Rec
186 --
187 -- PURPOSE
188 -- For Update_ListField, some attributes may be passed in as
189 -- FND_API.g_miss_char/num/date if the user doesn't want to
190 -- update those attributes. This procedure will replace the
191 -- "g_miss" attributes with current database values.
192 --
193 -- PARAMETERS
194 -- p_listdr_rec: the record which may contain attributes as
195 -- FND_API.g_miss_char/num/date
196 -- x_complete_rec: the complete record after all "g_miss" items
197 -- have been replaced by current database values
198 ---------------------------------------------------------------------
199 PROCEDURE Complete_ListField_Rec (
200 p_listfield_rec IN List_Field_Rec_Type,
201 x_complete_rec OUT List_Field_Rec_Type
202 );
203
204
205 END AMS_ListField_PVT;