1 package AK_AMPARAM_REGISTRY_PVT as
2 /* $Header: akdvaprs.pls 120.2 2005/09/15 22:26:44 tshort noship $ */
3 G_PKG_NAME VARCHAR2(30) := 'AK_AMPARAM_REGISTRY_PVT';
4
5 --=======================================================
6 -- Procedure DOWNLOAD_AMPARAM_REGISTRY
7 --
8 -- Usage Private API for downloading amparam_registry objects. This
9 -- API should only be called by other APIs that are
10 -- owned by the Core Modules Team (AK).
11 --
12 -- Desc This API will extract the amparam_registry objects selected
13 -- by application ID or by key values from the
14 -- database to the output file.
15 --
16 -- Results The API returns the standard p_return_status parameter
17 -- indicating one of the standard return statuses :
18 -- * Unexpected error
19 -- * Error
20 -- * Success
21 -- Parameters
22 -- p_nls_language : IN optional
23 -- NLS language for database. If none if given,
24 -- the current NLS language will be used.
25 --
26 -- One of the following parameters must be provided:
27 --
28 -- p_application_id : IN optional
29 -- If given, all attributes for this application ID
30 -- will be written to the output file.
31 -- p_application_id will be ignored if a table is
32 -- given in p_object_pk_tbl.
33 -- p_amparamreg_pk_tbl : IN optional
34 -- If given, only amparam_registry objects whose key values are
35 -- included in this table will be written to the
36 -- output file.
37 --
38 --
39 -- Version Initial version number = 1.0
40 -- History Current version number = 1.0
41 --=======================================================
42 procedure DOWNLOAD_AMPARAM_REGISTRY (
43 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
44 p_api_version_number IN NUMBER,
45 p_return_status OUT NOCOPY VARCHAR2,
46 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
47 p_amparamreg_pk_tbl IN AK_AMPARAM_REGISTRY_PUB.AmParamReg_Pk_Tbl_Type :=
48 AK_AMPARAM_REGISTRY_PUB.G_MISS_AMPARAMREG_PK_TBL,
49 p_nls_language IN VARCHAR2
50 );
51
52 --=======================================================
53 -- Procedure CREATE_AMPARAM_REGISTRY
54 --
55 -- Usage Private API for creating amparam_registry objects. This
56 -- API should only be called by other APIs that are
57 -- owned by the Core Modules Team (AK).
58 -- Desc Calls the private API to creates a amparam_registry object
59 -- using the given info
60 --
61 -- Results The API returns the standard p_return_status parameter
62 -- indicating one of the standard return statuses :
63 -- * Unexpected error
64 -- * Error
65 -- * Success
66 --=======================================================
67
68 PROCEDURE CREATE_AMPARAM_REGISTRY(
69 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
70 p_api_version_number IN NUMBER,
71 p_init_msg_tbl IN BOOLEAN := FALSE,
72 p_msg_count OUT NOCOPY NUMBER,
73 p_msg_data OUT NOCOPY VARCHAR2,
74 p_return_status OUT NOCOPY VARCHAR2,
75 p_applicationmodule_defn_name IN VARCHAR2,
76 p_param_name IN VARCHAR2,
77 p_param_value IN VARCHAR2,
78 p_application_id IN NUMBER,
79 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
80 p_pass IN NUMBER := 2
81 );
82
83 --=======================================================
84 -- Procedure UPDATE_AMPARAM_REGISTRY
85 --
86 -- Usage Private API for updating amparam_registry objects. This
87 -- API should only be called by other APIs that are
88 -- owned by the Core Modules Team (AK).
89 --
90 -- Desc Updates a amparam_registry using the given info.
91 -- This API should only be called by other APIs that are
92 -- owned by the Core Modules Team (AK).
93 --
94 -- Results The API returns the standard p_return_status parameter
95 -- indicating one of the standard return statuses :
96 -- * Unexpected error
97 -- * Error
98 -- * Success
99 -- Parameters Query Object columns
100 -- p_loader_timestamp : IN optional
101 -- If a timestamp is passed, the API will create the
102 -- record using this timestamp. Only the upload API
103 -- should call with this parameter loaded.
104 --=======================================================
105
106 PROCEDURE UPDATE_AMPARAM_REGISTRY(
107 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
108 p_api_version_number IN NUMBER,
109 p_init_msg_tbl IN BOOLEAN := FALSE,
110 p_msg_count OUT NOCOPY NUMBER,
111 p_msg_data OUT NOCOPY VARCHAR2,
112 p_return_status OUT NOCOPY VARCHAR2,
113 p_applicationmodule_defn_name IN VARCHAR2,
114 p_param_name IN VARCHAR2,
115 p_param_value IN VARCHAR2,
116 p_application_id IN NUMBER,
117 p_loader_timestamp IN DATE := FND_API.G_MISS_DATE,
118 p_pass IN NUMBER := 2);
119
120 --=======================================================
121 -- Procedure UPLOAD_AMPARAM_REGISTRY
122 --
123 -- Usage Private API for loading amparam_registry objects from a
124 -- loader file to the database.
125 -- This API should only be called by other APIs
126 -- that are owned by the Core Modules Team (AK).
127 --
128 -- Desc This API reads the amparam_registry data
129 -- stored in the loader file currently being
130 -- processed, parses the data, and loads them to the
131 -- database. The tables are updated with the timestamp
132 -- passed. This API will process the file until the
133 -- EOF is reached, a parse error is encountered, or when
134 -- data for a different business object is read from the file.
135 --
136 -- Results The API returns the standard p_return_status parameter
137 -- indicating one of the standard return statuses :
138 -- * Unexpected error
139 -- * Error
140 -- * Success
141 -- Parameters p_index : IN OUT required
142 -- Index of PL/SQL file to be processed.
143 -- p_loader_timestamp : IN required
144 -- The timestamp to be used when creating or updating
145 -- records
146 -- p_line_num : IN optional
147 -- The first line number in the file to be processed.
148 -- It is used for keeping track of the line number
149 -- read so that this info can be included in the
150 -- error message when a parse error occurred.
151 -- p_buffer : IN required
152 -- The content of the first line to be processed.
153 -- The calling API has already read the first line
154 -- that needs to be parsed by this API, so this
155 -- line won't be read from the file again.
156 -- p_line_num_out : OUT
157 -- The number of the last line in the loader file
158 -- that is read by this API.
159 -- p_buffer_out : OUT
160 -- The content of the last line read by this API.
161 -- If an EOF has not reached, this line would
162 -- contain the beginning of another business object
163 -- that will need to be processed by another API.
164 --
165 -- Version Initial version number = 1.0
166 -- History Current version number = 1.0
167 --=======================================================
168 procedure UPLOAD_AMPARAM_REGISTRY (
169 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
170 p_api_version_number IN NUMBER,
171 p_return_status OUT NOCOPY VARCHAR2,
172 p_index IN OUT NOCOPY NUMBER,
173 p_loader_timestamp IN DATE,
174 p_line_num IN NUMBER := FND_API.G_MISS_NUM,
175 p_buffer IN AK_ON_OBJECTS_PUB.Buffer_Type,
176 p_line_num_out OUT NOCOPY NUMBER,
177 p_buffer_out OUT NOCOPY AK_ON_OBJECTS_PUB.Buffer_Type,
178 p_upl_loader_cur IN OUT NOCOPY AK_ON_OBJECTS_PUB.LoaderCurTyp,
179 p_pass IN NUMBER := 1
180 );
181
182 END AK_AMPARAM_REGISTRY_PVT;
[Home] [Help]