[Home] [Help]
PACKAGE: APPS.BOM_REF_DESIGNATOR_UTIL
Source
1 PACKAGE BOM_Ref_Designator_Util AS
2 /* $Header: BOMURFDS.pls 120.0 2005/05/25 05:17:50 appldev noship $ */
3 /*#
4 * This API contains entity utility method for the Bill of Materials Reference
5 * Designators.
6 * @rep:scope private
7 * @rep:product BOM
8 * @rep:displayname BOM Reference Designator Util Package
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY BOM_BILL_OF_MATERIAL
11 */
12 /***************************************************************************
13 --
14 -- Copyright (c) 1996 Oracle Corporation, Redwood Shores, CA, USA
15 -- All rights reserved.
16 --
17 -- FILENAME
18 --
19 -- BOMURFDS.pls
20 --
21 -- DESCRIPTION
22 --
23 -- Spec of package BOM_Ref_Designator_Util
24 --
25 -- NOTES
26 --
27 -- HISTORY
28 --
29 -- 19-JUL-1999 Rahul Chitko Initial Creation
30 --
31 *****************************************************************************/
32 -- Attributes global constants
33
34 G_REF_DESIGNATOR CONSTANT NUMBER := 1;
35 G_LAST_UPDATE_DATE CONSTANT NUMBER := 2;
36 G_LAST_UPDATED_BY CONSTANT NUMBER := 3;
37 G_CREATION_DATE CONSTANT NUMBER := 4;
38 G_CREATED_BY CONSTANT NUMBER := 5;
39 G_LAST_UPDATE_LOGIN CONSTANT NUMBER := 6;
40 G_REF_DESIGNATOR_COMMENT CONSTANT NUMBER := 7;
41 G_CHANGE_NOTICE CONSTANT NUMBER := 8;
42 G_COMPONENT_SEQUENCE CONSTANT NUMBER := 9;
43 G_ACD_TYPE CONSTANT NUMBER := 10;
44 G_REQUEST CONSTANT NUMBER := 11;
45 G_PROGRAM_APPLICATION CONSTANT NUMBER := 12;
46 G_PROGRAM CONSTANT NUMBER := 13;
47 G_PROGRAM_UPDATE_DATE CONSTANT NUMBER := 14;
48 G_ATTRIBUTE_CATEGORY CONSTANT NUMBER := 15;
49 G_ATTRIBUTE1 CONSTANT NUMBER := 16;
50 G_ATTRIBUTE2 CONSTANT NUMBER := 17;
51 G_ATTRIBUTE3 CONSTANT NUMBER := 18;
52 G_ATTRIBUTE4 CONSTANT NUMBER := 19;
53 G_ATTRIBUTE5 CONSTANT NUMBER := 20;
54 G_ATTRIBUTE6 CONSTANT NUMBER := 21;
55 G_ATTRIBUTE7 CONSTANT NUMBER := 22;
56 G_ATTRIBUTE8 CONSTANT NUMBER := 23;
57 G_ATTRIBUTE9 CONSTANT NUMBER := 24;
58 G_ATTRIBUTE10 CONSTANT NUMBER := 25;
59 G_ATTRIBUTE11 CONSTANT NUMBER := 26;
60 G_ATTRIBUTE12 CONSTANT NUMBER := 27;
61 G_ATTRIBUTE13 CONSTANT NUMBER := 28;
62 G_ATTRIBUTE14 CONSTANT NUMBER := 29;
63 G_ATTRIBUTE15 CONSTANT NUMBER := 30;
64 G_MAX_ATTR_ID CONSTANT NUMBER := 31;
65
66 -- Procedure Clear_Dependent_Attr
67
68 /*#
69 * Clear Dependent Attributes
70 * @param p_attr_id attribute id
71 * @param p_ref_designator_rec reference designator record
72 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
73 * @param p_old_ref_designator_rec old reference designator record. This is defaulted to
74 * Bom_Bo_Pub.G_MISS_REF_DESIGNATOR_REC
75 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
76 * @param x_ref_designator_rec returned reference designator record
77 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
78 * @rep:scope private
79 * @rep:lifecycle active
80 * @rep:displayname Clear Dependent Attributes
81 */
82
83
84 PROCEDURE Clear_Dependent_Attr
85 ( p_attr_id IN NUMBER := FND_API.G_MISS_NUM
86 , p_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_Rec_Type
87 , p_old_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_Rec_Type :=
88 Bom_Bo_Pub.G_MISS_REF_DESIGNATOR_REC
89 , x_ref_designator_rec IN OUT NOCOPY Bom_Bo_Pub.Ref_Designator_Rec_Type
90 );
91
92 -- Procedure Apply_Attribute_Changes
93
94 /*#
95 * Apply Attribute Changes
96 * @param p_ref_designator_rec reference designator record
97 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
98 * @param p_old_ref_designator_rec old reference designator record. This is defaulted to
99 * Bom_Bo_Pub.G_MISS_REF_DESIGNATOR_REC
100 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
101 * @param x_ref_designator_rec returned reference designator record
102 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
103 * @rep:scope private
104 * @rep:lifecycle active
105 * @rep:displayname Apply Attribute Changes
106 */
107
108 PROCEDURE Apply_Attribute_Changes
109 ( p_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_Rec_Type
110 , p_old_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_Rec_Type :=
111 Bom_Bo_Pub.G_MISS_REF_DESIGNATOR_REC
112 , x_ref_designator_rec IN OUT NOCOPY Bom_Bo_Pub.Ref_Designator_Rec_Type
113 );
114
115 -- Function Convert_Miss_To_Null
116
117 /*#
118 * This method will convert the missing values of some attributes that the user wishes to NULL
119 * This can be used with ECO
120 * @param p_ref_designator_rec the record that need to be converted
121 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
122 * @return the converted record
123 * @rep:scope private
124 * @rep:lifecycle active
125 * @rep:displayname Convert Miss To Null
126 */
127
128
129 FUNCTION Convert_Miss_To_Null
130 ( p_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_Rec_Type
131 ) RETURN Bom_Bo_Pub.Ref_Designator_Rec_Type;
132
133 -- Function Query_Row
134
135 /*#
136 * This method will query the database record, seperate the values into exposed columns
137 * and unexposed columns and return with those records.This can be used with ECO
138 * @param p_ref_designator This with the next two parameters form Reference Designator Key
139 * @param p_component_sequence_id component sequence id
140 * @param p_acd_type acd type
141 * @param x_Ref_Designator_Rec Reference Designator Record of exposed columns
142 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_Rec_Type }
143 * @param x_Ref_Desg_Unexp_Rec Reference Designator Record of Unexposed Columns
144 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Desg_Unexposed_Rec_Type}
145 * @param x_Return_Status Indicating success or faliure
146 * @rep:scope private
147 * @rep:lifecycle active
148 * @rep:displayname Query Row
149 */
150
151
152 PROCEDURE Query_Row
153 ( p_ref_designator IN VARCHAR2
154 , p_component_sequence_id IN NUMBER
155 , p_acd_type IN NUMBER
156 , x_Ref_Designator_Rec IN OUT NOCOPY Bom_Bo_Pub.Ref_Designator_Rec_Type
157 , x_Ref_Desg_Unexp_Rec IN OUT NOCOPY Bom_Bo_Pub.Ref_Desg_Unexposed_Rec_Type
158 , x_Return_Status IN OUT NOCOPY VARCHAR2
159 );
160
161 /*#
162 * Perform Writes is the only exposed method that the user will have access, to perform
163 * any insert/update/deletes to corresponding database tables . This can be used with ECO
164 * @param p_ref_designator_rec Reference Designator exposed column record
165 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Designator_rec_Type }
166 * @param p_ref_desg_unexp_rec Reference Designator unexposed column record
167 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Ref_Desg_Unexposed_Rec_Type }
168 * @param p_control_rec control record.This is defaulted as BOM_BO_PUB.G_DEFAULT_CONTROL_REC
169 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Control_Rec_Type }
170 * @param x_Mesg_Token_Tbl Message token table
171 * @rep:paraminfo { @rep:innertype Error_Handler.Mesg_Token_Tbl_Type }
172 * @param x_Return_status Return Status
173 * @rep:scope private
174 * @rep:lifecycle active
175 * @rep:displayname Perform Writes
176 */
177
178 PROCEDURE Perform_Writes
179 ( p_ref_designator_rec IN Bom_Bo_Pub.Ref_Designator_rec_Type
180 , p_ref_desg_unexp_rec IN Bom_Bo_Pub.Ref_Desg_Unexposed_Rec_Type
181 , p_control_rec IN BOM_BO_PUB.Control_Rec_Type
182 := BOM_BO_PUB.G_DEFAULT_CONTROL_REC
183 , x_mesg_token_tbl IN OUT NOCOPY Error_Handler.Mesg_Token_Tbl_Type
184 , x_return_status IN OUT NOCOPY VARCHAR2
185 );
186
187 /*
188 ** Definitions for the BOM Business Object
189 */
190
191
192 /*#
193 * This method will convert the missing values of some attributes that the user wishes to NULL
194 * @param p_bom_ref_designator_rec the record that need to be converted
195 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Bom_Ref_Designator_Rec_Type }
196 * @return the converted record
197 * @rep:scope private
198 * @rep:lifecycle active
199 * @rep:displayname Convert Miss To Null
200 */
201 FUNCTION Convert_Miss_To_Null
202 ( p_bom_ref_designator_rec IN Bom_Bo_Pub.Bom_Ref_Designator_Rec_Type
203 ) RETURN Bom_Bo_Pub.Bom_Ref_Designator_Rec_Type;
204
205 -- Function Query_Row
206
207
208 /*#
209 * This method will query the database record, seperate the values into exposed columns
210 * and unexposed columns and return with those records
211 * @param p_bom_ref_designator This with the next two parameters form Reference Designator Key
212 * @param p_component_sequence_id component sequence id
213 * @param p_acd_type acd type
214 * @param x_bom_Ref_Designator_Rec Reference Designator Record of exposed columns
215 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Bom_Ref_Designator_Rec_Type }
216 * @param x_bom_Ref_Desg_Unexp_Rec Reference Designator Record of Unexposed Columns
217 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Bom_Ref_Desg_Unexposed_Rec_Type}
218 * @param x_Return_Status Indicating success or faliure
219 * @rep:scope private
220 * @rep:lifecycle active
221 * @rep:displayname Query Row
222 */
223
224 PROCEDURE Query_Row
225 ( p_bom_ref_designator IN VARCHAR2
226 , p_component_sequence_id IN NUMBER
227 , p_acd_type IN NUMBER
228 , x_bom_Ref_Designator_Rec IN OUT NOCOPY Bom_Bo_Pub.Bom_Ref_Designator_Rec_Type
229 , x_bom_Ref_Desg_Unexp_Rec IN OUT NOCOPY Bom_Bo_Pub.Bom_Ref_Desg_Unexp_Rec_Type
230 , x_Return_Status IN OUT NOCOPY VARCHAR2
231 );
232
233 /*#
234 * Perform Writes is the only exposed method that the user will have access to perform any
235 * insert/update/deletes to corresponding database tables
236 * @param p_bom_ref_designator_rec BomReference Designator exposed column record
237 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Bom_Ref_Designator_rec_Type }
238 * @param p_bom_ref_desg_unexp_rec Bom Reference Designator unexposed column record
239 * @rep:paraminfo { @rep:innertype Bom_Bo_Pub.Bom_Ref_Desg_Unexposed_Rec_Type }
240 * @param x_Mesg_Token_Tbl Message token table
241 * @rep:paraminfo { @rep:innertype Error_Handler.Mesg_Token_Tbl_Type }
242 * @param x_Return_status Return Status
243 * @rep:scope private
244 * @rep:lifecycle active
245 * @rep:displayname Perform Writes
246 */
247
248 PROCEDURE Perform_Writes
249 ( p_bom_ref_designator_rec IN Bom_Bo_Pub.Bom_Ref_Designator_rec_Type
250 , p_bom_ref_desg_unexp_rec IN Bom_Bo_Pub.Bom_Ref_Desg_Unexp_Rec_Type
251 , x_mesg_token_tbl IN OUT NOCOPY Error_Handler.Mesg_Token_Tbl_Type
252 , x_return_status IN OUT NOCOPY VARCHAR2
253 );
254
255 END BOM_Ref_Designator_Util;