1 Package pqh_budget_gl_flex_maps_api as
2 /* $Header: pqbgmapi.pkh 120.2 2006/06/05 19:10:33 nsanghal noship $ */
3 /*#
4 * This package contains APIs to create, update or delete cost allocations with
5 * GL code combinations.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Budget General Ledger Flexfield Mapping
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_budget_gl_flex_map >---------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates mapping of cost allocations with GL code combinations.
18 *
19 * When GL mapping is enabled, this API allows the mapping of HR's cost
20 * allocations with GL's Ledger.
21 *
22 * <p><b>Licensing</b><br>
23 * This API is licensed for use with Human Resources.
24 *
25 * <p><b>Prerequisites</b><br>
26 * Budget should exist and transfer to GL should be enabled. Cost allocation
27 * should exist. Ledger should exist.
28 *
29 * <p><b>Post Success</b><br>
30 * Budget GL flexfield mapping for a budget will be inserted in the database.
31 *
32 * <p><b>Post Failure</b><br>
33 * Budget GL flexfield mapping will not be created and an error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_budget_gl_flex_map_id If p_validate is false, then this uniquely
38 * identifies the budget GL Flex Map created. If p_validate is true, then set
39 * to null.
40 * @param p_budget_id Budget identifier.
41 * @param p_gl_account_segment GL account combination segment.
42 * @param p_payroll_cost_segment Payroll cost allocation segment.
43 * @param p_object_version_number If p_validate is false, then set to the
44 * version number of the created budget GL Flex Map. If p_validate is true,
45 * then the value will be null.
46 * @rep:displayname Create Budget General Ledger Flexfield Mapping
47 * @rep:category BUSINESS_ENTITY HR_BUDGET
48 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
49 * @rep:scope public
50 * @rep:lifecycle active
51 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
52 */
53 --
54 -- {End Of Comments}
55 --
56 procedure create_budget_gl_flex_map
57 (
58 p_validate in boolean default false
59 ,p_budget_gl_flex_map_id out nocopy number
60 ,p_budget_id in number default null
61 ,p_gl_account_segment in varchar2 default null
62 ,p_payroll_cost_segment in varchar2 default null
63 ,p_object_version_number out nocopy number
64 );
65 --
66 -- ----------------------------------------------------------------------------
67 -- |------------------------< update_budget_gl_flex_map >---------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- {Start Of Comments}
71 /*#
72 * This API updates cost allocations mapped with GL code combinations.
73 *
74 * When GL mapping is enabled, this API updates the mapping of HR's cost
75 * allocations with GL's Ledger.
76 *
77 * <p><b>Licensing</b><br>
78 * This API is licensed for use with Human Resources.
79 *
80 * <p><b>Prerequisites</b><br>
81 * The GL flexfield mapping to be updated should exist. Budget should exist and
82 * transfer to GL should be enabled. Cost allocation should exist. Ledger
83 * should exist.
84 *
85 * <p><b>Post Success</b><br>
86 * Budget GL flexfield mapping for a budget will be updated in the database.
87 *
88 * <p><b>Post Failure</b><br>
89 * Budget GL flexfield mapping will not be updated and an error will be raised.
90 * @param p_validate If true, then validation alone will be performed and the
91 * database will remain unchanged. If false and all validation checks pass,
92 * then the database will be modified.
93 * @param p_budget_gl_flex_map_id Identifies the budget GL flexfield mapping.
94 * @param p_budget_id Budget identifier.
95 * @param p_gl_account_segment GL account combination segment.
96 * @param p_payroll_cost_segment Cost allocation.
97 * @param p_object_version_number Pass in the current version number of the
98 * budget GL Flex Maps to be updated. When the API completes if p_validate is
99 * false, will be set to the new version number of the updated budget GL Flex
100 * Map. If p_validate is true will be set to the same value which was passed
101 * in.
102 * @rep:displayname Update Budget General Ledger Flexfield Mapping
103 * @rep:category BUSINESS_ENTITY HR_BUDGET
104 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
105 * @rep:scope public
106 * @rep:lifecycle active
107 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
108 */
109 --
110 -- {End Of Comments}
111 --
112 procedure update_budget_gl_flex_map
113 (
114 p_validate in boolean default false
115 ,p_budget_gl_flex_map_id in number
116 ,p_budget_id in number default hr_api.g_number
117 ,p_gl_account_segment in varchar2 default hr_api.g_varchar2
118 ,p_payroll_cost_segment in varchar2 default hr_api.g_varchar2
119 ,p_object_version_number in out nocopy number
120 );
121 --
122 -- ----------------------------------------------------------------------------
123 -- |------------------------< delete_budget_gl_flex_map >---------------------|
124 -- ----------------------------------------------------------------------------
125 --
126 -- {Start Of Comments}
127 /*#
128 * This API deletes cost allocations mapped with GL code combinations.
129 *
130 * When GL mapping is enabled, this API deletes the mapping of HR's cost
131 * allocations with GL's Ledger.
132 *
133 * <p><b>Licensing</b><br>
134 * This API is licensed for use with Human Resources.
135 *
136 * <p><b>Prerequisites</b><br>
137 * The GL flexfield mapping to be deleted should exist.
138 *
139 * <p><b>Post Success</b><br>
140 * Budget GL flexfield mapping for a budget will be deleted in the database.
141 *
142 * <p><b>Post Failure</b><br>
143 * Budget GL flexfield mapping will not be deleted and an error will be raised.
144 * @param p_validate If true, then validation alone will be performed and the
145 * database will remain unchanged. If false and all validation checks pass,
146 * then the database will be modified.
147 * @param p_budget_gl_flex_map_id This uniquely identifies the budget GL
148 * flexfield mapping.
149 * @param p_object_version_number Current version number of the budget GL
150 * flexfield mapping to be deleted.
151 * @rep:displayname Delete Budget General Ledger Flexfield Mapping
152 * @rep:category BUSINESS_ENTITY HR_BUDGET
153 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
154 * @rep:scope public
155 * @rep:lifecycle active
156 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
157 */
158 --
159 -- {End Of Comments}
160 --
161 procedure delete_budget_gl_flex_map
162 (
163 p_validate in boolean default false
164 ,p_budget_gl_flex_map_id in number
165 ,p_object_version_number in number
166 );
167 --
168 end pqh_budget_gl_flex_maps_api;
[Home] [Help]