1 package AK_ATTRIBUTE_GRP as
2 /* $Header: akdgatts.pls 120.2 2005/09/15 22:26:31 tshort ship $ */
3
4 -- Global constants holding the package and file names to be used by
5 -- messaging routines in the case of an unexpected error.
6
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AK_ATTRIBUTE_GRP';
8
9 --
10 -- Procedure specs
11 --
12 --=======================================================
13 -- Procedure CREATE_ATTRIBUTE
14 --
15 -- Usage Group API for creating an attribute
16 --
17 -- Desc Calls the private API to creates an attribute
18 -- using the given info
19 --
20 -- Results The API returns the standard p_return_status parameter
21 -- indicating one of the standard return statuses :
22 -- * Unexpected error
23 -- * Error
24 -- * Success
25 -- Parameters Attribute columns
26 --
27 -- Version Initial version number = 1.0
28 -- History Current version number = 1.0
29 --=======================================================
30 procedure CREATE_ATTRIBUTE (
31 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
32 p_api_version_number IN NUMBER,
33 p_init_msg_tbl IN BOOLEAN := FALSE,
34 p_msg_count OUT NOCOPY NUMBER,
35 p_msg_data OUT NOCOPY VARCHAR2,
36 p_return_status OUT NOCOPY VARCHAR2,
37 p_attribute_application_id IN NUMBER,
38 p_attribute_code IN VARCHAR2,
39 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
40 p_attribute_value_length IN NUMBER := FND_API.G_MISS_NUM,
41 p_bold IN VARCHAR2,
42 p_italic IN VARCHAR2,
43 p_vertical_alignment IN VARCHAR2,
44 p_horizontal_alignment IN VARCHAR2,
45 p_data_type IN VARCHAR2,
46 p_upper_case_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
47 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
48 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
49 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
50 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
51 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
52 p_item_style IN VARCHAR2,
53 p_display_height IN NUMBER := FND_API.G_MISS_NUM,
54 p_css_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
55 p_poplist_viewobject IN VARCHAR2 := FND_API.G_MISS_CHAR,
56 p_poplist_display_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
57 p_poplist_value_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
58 p_css_label_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
59 p_precision IN NUMBER := FND_API.G_MISS_NUM,
60 p_expansion IN NUMBER := FND_API.G_MISS_NUM,
61 p_als_max_length IN NUMBER := FND_API.G_MISS_NUM,
62 p_name IN VARCHAR2,
63 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
64 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
65 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR
66 );
67
68 --=======================================================
69 -- Procedure DELETE_ATTRIBUTE
70 --
71 -- Usage Group API for deleting an attribute
72 --
73 -- Desc Calls the private API to deletes an attribute
74 -- with the given key value.
75 --
76 -- Results The API returns the standard p_return_status parameter
77 -- indicating one of the standard return statuses :
78 -- * Unexpected error
79 -- * Error
80 -- * Success
81 -- Parameters p_attribute_application_id : IN required
82 -- p_attribute_code : IN required
83 -- Key value of the attribute to be deleted.
84 -- p_delete_cascade : IN required
85 -- If p_delete_cascade flag is 'Y', also delete all
86 -- rows in other tables that references this attribute.
87 -- Otherwise, this attribute will not be deleted if there
88 -- are any other rows referencing it.
89 --
90 -- Version Initial version number = 1.0
91 -- History Current version number = 1.0
92 --=======================================================
93 procedure DELETE_ATTRIBUTE (
94 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
95 p_api_version_number IN NUMBER,
96 p_init_msg_tbl IN BOOLEAN := FALSE,
97 p_msg_count OUT NOCOPY NUMBER,
98 p_msg_data OUT NOCOPY VARCHAR2,
99 p_return_status OUT NOCOPY VARCHAR2,
100 p_attribute_application_id IN NUMBER,
101 p_attribute_code IN VARCHAR2,
102 p_delete_cascade IN VARCHAR2 := 'N'
103 );
104
105 --=======================================================
106 -- Procedure DOWNLOAD_ATTRIBUTE
107 --
108 -- Usage Group API for downloading attributes
109 --
110 -- Desc This API first write out standard loader
111 -- file header for attributes to a flat file.
112 -- Then it calls the private API to extract the
113 -- attributes selected by application ID or by
114 -- key values from the database to the output file.
115 --
116 -- Results The API returns the standard p_return_status parameter
117 -- indicating one of the standard return statuses :
118 -- * Unexpected error
119 -- * Error
120 -- * Success
121 -- Parameters
122 -- p_nls_language : IN optional
123 -- NLS language for database. If none if given,
124 -- the current NLS language will be used.
125 --
126 -- One of the following three parameters must be given:
127 --
128 -- p_application_id : IN optional
129 -- If given, all attributes for this application ID
130 -- will be written to the output file.
131 -- p_application_short_name : IN optional
132 -- If given, all attributes for this application short
133 -- name will be written to the output file.
134 -- Application short name will be ignored if an
135 -- application ID is given.
136 -- p_attribute_pk_tbl : IN optional
137 -- If given, only attributes whose key values are
138 -- included in this table will be written to the
139 -- output file.
140 --
141 --
142 -- Version Initial version number = 1.0
143 -- History Current version number = 1.0
144 --=======================================================
145 procedure DOWNLOAD_ATTRIBUTE (
146 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
147 p_api_version_number IN NUMBER,
148 p_init_msg_tbl IN BOOLEAN := FALSE,
149 p_msg_count OUT NOCOPY NUMBER,
150 p_msg_data OUT NOCOPY VARCHAR2,
151 p_return_status OUT NOCOPY VARCHAR2,
152 p_nls_language IN VARCHAR2 := FND_API.G_MISS_CHAR,
153 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
154 p_application_short_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
155 p_attribute_pk_tbl IN AK_ATTRIBUTE_PUB.Attribute_PK_Tbl_Type :=
156 AK_ATTRIBUTE_PUB.G_MISS_ATTRIBUTE_PK_TBL
157 );
158
159 --=======================================================
160 -- Procedure UPDATE_ATTRIBUTE
161 --
162 -- Usage Group API for updating an attribute
163 --
164 -- Desc This API calls the private API to update
165 -- an attribute using the given info
166 --
167 -- Results The API returns the standard p_return_status parameter
168 -- indicating one of the standard return statuses :
169 -- * Unexpected error
170 -- * Error
171 -- * Success
172 -- Parameters Attribute columns
173 --
174 -- Version Initial version number = 1.0
175 -- History Current version number = 1.0
176 --=======================================================
177 procedure UPDATE_ATTRIBUTE (
178 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
179 p_api_version_number IN NUMBER,
180 p_init_msg_tbl IN BOOLEAN := FALSE,
181 p_msg_count OUT NOCOPY NUMBER,
182 p_msg_data OUT NOCOPY VARCHAR2,
183 p_return_status OUT NOCOPY VARCHAR2,
184 p_attribute_application_id IN NUMBER,
185 p_attribute_code IN VARCHAR2,
186 p_attribute_label_length IN NUMBER := FND_API.G_MISS_NUM,
187 p_attribute_value_length IN NUMBER := FND_API.G_MISS_NUM,
188 p_bold IN VARCHAR2 := FND_API.G_MISS_CHAR,
189 p_italic IN VARCHAR2 := FND_API.G_MISS_CHAR,
190 p_vertical_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
191 p_horizontal_alignment IN VARCHAR2 := FND_API.G_MISS_CHAR,
192 p_data_type IN VARCHAR2 := FND_API.G_MISS_CHAR,
193 p_upper_case_flag IN VARCHAR2 := FND_API.G_MISS_CHAR,
194 p_default_value_varchar2 IN VARCHAR2 := FND_API.G_MISS_CHAR,
195 p_default_value_number IN NUMBER := FND_API.G_MISS_NUM,
196 p_default_value_date IN DATE := FND_API.G_MISS_DATE,
197 p_lov_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
198 p_lov_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
199 p_item_style IN VARCHAR2,
200 p_display_height IN NUMBER := FND_API.G_MISS_NUM,
201 p_css_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
202 p_poplist_viewobject IN VARCHAR2 := FND_API.G_MISS_CHAR,
203 p_poplist_display_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
204 p_poplist_value_attr IN VARCHAR2 := FND_API.G_MISS_CHAR,
205 p_css_label_class_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
206 p_precision IN NUMBER := FND_API.G_MISS_NUM,
207 p_expansion IN NUMBER := FND_API.G_MISS_NUM,
208 p_als_max_length IN NUMBER := FND_API.G_MISS_NUM,
209 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
210 p_attribute_label_long IN VARCHAR2 := FND_API.G_MISS_CHAR,
211 p_attribute_label_short IN VARCHAR2 := FND_API.G_MISS_CHAR,
212 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR
213 );
214
215 end AK_ATTRIBUTE_GRP;