1 PACKAGE GL_ACCOUNTS_MAP_GRP AUTHID CURRENT_USER as
2 /* $Header: glgcmaps.pls 120.4.12010000.1 2008/07/28 13:22:35 appldev ship $ */
3
4 --
5 -- Package
6 -- GL_ACCOUNTS_MAP_GRP
7 -- Purpose
8 -- API for Chart of Accounts Mapping
9 -- History
10 -- 08-MAY-2002 M. Ward Created.
11 --
12
13 -- This exception is raised when there is no mapping with the mapping name
14 -- specified in the parameter of the map procedure
15 GL_INVALID_MAPPING_NAME EXCEPTION;
16
17 -- This exception is raised when the mapping is disabled because the
18 -- current date is outside the active date range for the mapping
19 GL_DISABLED_MAPPING EXCEPTION;
20
21 -- This exception is raised when the mapping rules are incorrectly defined
22 GL_INVALID_MAPPING_RULES EXCEPTION;
23
24 -- This exception is raised when any other error occurs
25 GL_MAP_UNEXPECTED_ERROR EXCEPTION;
26
27
28 -- The source chart of accounts has no balancing segment
29 GL_BSV_MAP_NO_SOURCE_BAL_SEG EXCEPTION;
30
31 -- The target chart of accounts has no balancing segment
32 GL_BSV_MAP_NO_TARGET_BAL_SEG EXCEPTION;
33
34 -- Raised when there is no segment mapping for the balancing segment
35 GL_BSV_MAP_NO_SEGMENT_MAP EXCEPTION;
36
37 -- Raised when there is no single value to assign to the balancing segment
38 GL_BSV_MAP_NO_SINGLE_VALUE EXCEPTION;
39
40 -- Raised when there is no derive-from segment
41 GL_BSV_MAP_NO_FROM_SEGMENT EXCEPTION;
42
43 -- Raised when the derive-from segment is not the balancing segment
44 GL_BSV_MAP_NOT_BSV_DERIVED EXCEPTION;
45
46 -- This exception is raised when the mapping setup information could not
47 -- be obtained
48 GL_BSV_MAP_SETUP_ERROR EXCEPTION;
49
50 -- This exception is raised when the mapping could not be performed
51 GL_BSV_MAP_MAPPING_ERROR EXCEPTION;
52
53 -- This exception is raised when an unexpected error occurs in getting the
54 -- BSV mapping information
55 GL_BSV_MAP_UNEXPECTED_ERROR EXCEPTION;
56
57
58 --
59 -- Procedure
60 -- map
61 -- Purpose
62 -- This retrieves the code combinations from the FROM_CCID column of the
63 -- GL_ACCOUNTS_MAP_INTERFACE table. Then uses the chart of accounts
64 -- mapping specified in the argument to map these code combinations and
65 -- populate the TO_CCID AND TO_SEGMENT<x> columns. This will create new
66 -- code combinations if create_ccid is true. If not, this will leave
67 -- TO_CCID null for all segment-mapped accounts.
68 -- History
69 -- 09-MAY-2002 M. Ward Created
70 -- Arguments
71 -- mapping_name Name of the mapping to use
72 -- create_ccid Whether or not to create new code combinations
73 -- for the target chart of accounts
74 -- debug Whether or not to print debug messages
75 -- Example
76 -- GL_ACCOUNTS_MAP_GRP.map(
77 -- 'MY_MAPPING',
78 -- TRUE);
79 -- Notes
80 --
81 PROCEDURE map(mapping_name IN VARCHAR2,
82 create_ccid IN BOOLEAN DEFAULT TRUE,
83 debug IN BOOLEAN DEFAULT FALSE
84 );
85
86
87 --
88 -- Procedure
89 -- map
90 -- Purpose
91 -- This retrieves the code combinations from the FROM_CCID column of the
92 -- GL_ACCOUNTS_MAP_INTERFACE table. Then uses the chart of accounts
93 -- mapping specified in the argument to map these code combinations and
94 -- populate the TO_CCID AND TO_SEGMENT<x> columns. This will create new
95 -- code combinations if create_ccid is true. If not, this will leave
96 -- TO_CCID null for all segment-mapped accounts. This adheres to the Oracle
97 -- Applications Business Object API Coding Standards.
98 -- History
99 -- 14-JUN-2002 M. Ward Created
100 -- Arguments
101 -- p_api_version API version string
102 -- p_init_msg_list whether or not to initialize the message list
103 -- x_return_status Success, error, or unexpected error
104 -- x_msg_count number of messages in the message list
105 -- x_msg_data if there is only one message in the message
106 -- list, gives that message.
107 -- p_mapping_name Name of the mapping to use
108 -- p_create_ccid Whether or not to create new code combinations
109 -- for the target chart of accounts
110 -- p_debug Whether or not to print debug messages
111 -- Example
112 -- GL_ACCOUNTS_MAP_GRP.Map_Account(
113 -- p_mapping_name => 'MY_MAPPING',
114 -- p_create_ccid => FND_API.G_TRUE);
115 -- Notes
116 --
117 PROCEDURE Map_Account(p_api_version IN NUMBER,
118 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
119 x_return_status OUT NOCOPY VARCHAR2,
120 x_msg_count OUT NOCOPY NUMBER,
121 x_msg_data OUT NOCOPY VARCHAR2,
122 p_mapping_name IN VARCHAR2,
123 p_create_ccid IN VARCHAR2 DEFAULT FND_API.G_TRUE,
124 p_debug IN VARCHAR2 DEFAULT FND_API.G_FALSE
125 );
126
127 --
128 -- Procedure
129 -- map_bsvs
130 -- Purpose
131 -- This gets the list of source BSV values from the global temporary table
132 -- GL_ACCOUNTS_MAP_BSVS_GT and derives the target BSV values for those,
133 -- populating the target column of that global temporary table. If the
134 -- target BSV derivation is not a single value and is not derived from the
135 -- source chart of account's BSV, an error is raised.
136 -- History
137 -- 13-MAY-2004 M. Ward Created
138 -- Arguments
139 -- p_mapping_name Name of the mapping to use
140 -- p_debug Whether or not to print debug messages
141 -- Example
142 -- GL_ACCOUNTS_MAP_GRP.map_bsvs
143 -- (p_mapping_name => 'MY_MAPPING');
144 -- Notes
145 --
146 PROCEDURE map_bsvs( p_mapping_name IN VARCHAR2,
147 p_debug IN BOOLEAN);
148
149 --
150 -- Procedure
151 -- Populate_BSV_Targets
152 -- Purpose
153 -- This gets the list of source BSV values from the global temporary table
154 -- GL_ACCOUNTS_MAP_BSVS_GT and derives the target BSV values for those,
155 -- populating the target column of that global temporary table. If the
156 -- target BSV derivation is not a single value and is not derived from the
157 -- source chart of account's BSV, an error is raised. This adheres to the
158 -- Oracle Applications Business Object API Coding Standards.
159 -- History
160 -- 12-MAY-2004 M. Ward Created
161 -- Arguments
162 -- p_api_version API version string
163 -- p_init_msg_list whether or not to initialize the message list
164 -- x_return_status Success, error, or unexpected error
165 -- x_msg_count number of messages in the message list
166 -- x_msg_data if there is only one message in the message
167 -- list, gives that message.
168 -- p_mapping_name Name of the mapping to use
169 -- p_debug Whether or not to print debug messages
170 -- Example
171 -- GL_ACCOUNTS_MAP_GRP.Populate_BSV_Targets
172 -- (p_mapping_name => 'MY_MAPPING');
173 -- Notes
174 --
175 PROCEDURE Populate_BSV_Targets
176 (p_api_version IN NUMBER,
177 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
178 x_return_status OUT NOCOPY VARCHAR2,
179 x_msg_count OUT NOCOPY NUMBER,
180 x_msg_data OUT NOCOPY VARCHAR2,
181 p_mapping_name IN VARCHAR2,
182 p_debug IN VARCHAR2 DEFAULT FND_API.G_FALSE
183 );
184
185
186 --
187 -- Procedure
188 -- map_qualified_segment
189 -- Purpose
190 -- This gets the list of source segment values from the global temporary
191 -- GL_ACCOUNTS_MAP_BSVS_GT and derives the target segment values for those,
192 -- populating the target column of that global temporary table. If the
193 -- target segment derivation is not a single value and is not derived from
194 -- the source chart of account's segment with the same qualifier as the
195 -- target, an error is raised.
196 -- History
197 -- 10-JAN-2005 M. Ward Created
198 -- Arguments
199 -- p_mapping_name Name of the mapping to use
200 -- p_qualifier Segment qualifier
201 -- p_debug Whether or not to print debug messages
202 -- Example
203 -- GL_ACCOUNTS_MAP_GRP.map_qualified_segment
204 -- (p_mapping_name => 'MY_MAPPING');
205 -- Notes
206 --
207 PROCEDURE map_qualified_segment( p_mapping_name IN VARCHAR2,
208 p_qualifier IN VARCHAR2,
209 p_debug IN BOOLEAN);
210
211 --
212 -- Procedure
213 -- Populate_Qual_Segment_Targets
214 -- Purpose
215 -- This gets the list of source segment values from the global temporary
216 -- GL_ACCOUNTS_MAP_BSVS_GT and derives the target segment values for those,
217 -- populating the target column of that global temporary table. If the
218 -- target segment derivation is not a single value and is not derived from
219 -- the source chart of account's segment with the same qualifier as the
220 -- target, an error is raised. This adheres to the Oracle Applications
221 -- Business Object API Coding Standards.
222 -- History
223 -- 10-JAN-2005 M. Ward Created
224 -- Arguments
225 -- p_api_version API version string
226 -- p_init_msg_list whether or not to initialize the message list
227 -- x_return_status Success, error, or unexpected error
228 -- x_msg_count number of messages in the message list
229 -- x_msg_data if there is only one message in the message
230 -- list, gives that message.
231 -- p_mapping_name Name of the mapping to use
232 -- p_qualifier Segment qualifier
233 -- p_debug Whether or not to print debug messages
234 -- Example
235 -- GL_ACCOUNTS_MAP_GRP.Populate_Qual_Segment_Targets
236 -- (p_mapping_name => 'MY_MAPPING');
237 -- Notes
238 --
239 PROCEDURE Populate_Qual_Segment_Targets
240 (p_api_version IN NUMBER,
241 p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
242 x_return_status OUT NOCOPY VARCHAR2,
243 x_msg_count OUT NOCOPY NUMBER,
244 x_msg_data OUT NOCOPY VARCHAR2,
245 p_mapping_name IN VARCHAR2,
246 p_qualifier IN VARCHAR2,
247 p_debug IN VARCHAR2 DEFAULT FND_API.G_FALSE
248 );
249
250
251 END GL_ACCOUNTS_MAP_GRP;
[Home] [Help]