1 Package per_bf_balance_types_api as
2 /* $Header: pebbtapi.pkh 120.1 2005/10/02 02:12:04 aroussel $ */
3 /*#
4 * This package contains APIs that will maintain backfeed balance types for
5 * customers who are using a third party payroll application.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Backfeed Balance Type
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_balance_type >------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates new backfeed balance type information.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * Business group must be created for linking the balance amount.
25 *
26 * <p><b>Post Success</b><br>
27 * The backfeed balance type will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The backfeed balance type will not be created and an error will be raised.
31 * @param p_balance_type_id Uniquely identifies the backfeed balance type
32 * record to create.
33 * @param p_object_version_number If p_validate is false, then set to the
34 * version number of the created backfeed balance type. If p_validate is true,
35 * then the value will be null.
36 * @param p_input_value_id Internal identifier of the element types input
37 * value.
38 * @param p_business_group_id Business group in which the balance type is
39 * created.
40 * @param p_displayed_name Name of the balance type to be displayed on forms
41 * and reports.
42 * @param p_internal_name Internal name of the balance type.
43 * @param p_uom Unit of Measure for the balance.
44 * @param p_currency Currency of the balance type.
45 * @param p_category Category to group the types.
46 * @param p_date_from Date the type is valid from.
47 * @param p_date_to Date the type is valid to.
48 * @param p_validate If true, then validation alone will be performed and the
49 * database will remain unchanged. If false and all validation checks pass,
50 * then the database will be modified.
51 * @param p_effective_date Reference date for validating lookup values are
52 * applicable during the start to end active date range. This date does not
53 * determine when the changes take effect.
54 * @rep:displayname Create Backfeed Balance Type
55 * @rep:category BUSINESS_ENTITY PER_BF_BALANCE
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
57 * @rep:scope public
58 * @rep:lifecycle active
59 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
60 */
61 --
62 -- {End Of Comments}
63 --
64 procedure create_balance_type
65 ( p_balance_type_id out nocopy number
66 ,p_object_version_number out nocopy number
67 --
68 ,p_input_value_id in number default null
69 ,p_business_group_id in number
70 ,p_displayed_name in varchar2
71 ,p_internal_name in varchar2
72 ,p_uom in varchar2 default null
73 ,p_currency in varchar2 default null
74 ,p_category in varchar2 default null
75 ,p_date_from in date default null
76 ,p_date_to in date default null
77 ,p_validate in boolean default false
78 ,p_effective_date in date
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |---------------------------< update_balance_type >------------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates new backfeed balance type information.
88 *
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Human Resources.
92 *
93 * <p><b>Prerequisites</b><br>
94 * A valid business type must be passed to the API.
95 *
96 * <p><b>Post Success</b><br>
97 * The backfeed balance type will be successfully updated into the database.
98 *
99 * <p><b>Post Failure</b><br>
100 * The backfeed balance type will not be updated and an error will be raised.
101 * @param p_balance_type_id Uniquely identifies the backfeed balance type
102 * record to update.
103 * @param p_input_value_id Internal identifier of the element types input
104 * value.
105 * @param p_displayed_name Name of the balance type to be displayed on forms
106 * and reports
107 * @param p_internal_name Internal name of the balance type.
108 * @param p_uom Unit of Measure for the balance.
109 * @param p_currency Currency of the balance type.
110 * @param p_category Category to group the types.
111 * @param p_date_from Date the type is valid from.
112 * @param p_date_to Date the type is valid to.
113 * @param p_validate If true, then validation alone will be performed and the
114 * database will remain unchanged. If false and all validation checks pass,
115 * then the database will be modified.
116 * @param p_effective_date Reference date for validating lookup values are
117 * applicable during the start to end active date range. This date does not
118 * determine when the changes take effect.
119 * @param p_object_version_number Pass in the current version number of the
120 * backfeed balance type to be updated. When the API completes if p_validate is
121 * false, will be set to the new version number of the updated backfeed balance
122 * amount. If p_validate is true will be set to the same value which was passed
123 * in.
124 * @rep:displayname Update Backfeed Balance Type
125 * @rep:category BUSINESS_ENTITY PER_BF_BALANCE
126 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
127 * @rep:scope public
128 * @rep:lifecycle active
129 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
130 */
131 --
132 -- {End Of Comments}
133 --
134 procedure update_balance_type
135 ( p_balance_type_id in number
136 ,p_input_value_id in number default hr_api.g_number
137 ,p_displayed_name in varchar2 default hr_api.g_varchar2
138 ,p_internal_name in varchar2 default hr_api.g_varchar2
139 ,p_uom in varchar2 default hr_api.g_varchar2
140 ,p_currency in varchar2 default hr_api.g_varchar2
141 ,p_category in varchar2 default hr_api.g_varchar2
142 ,p_date_from in date default hr_api.g_date
143 ,p_date_to in date default hr_api.g_date
144 ,p_validate in boolean default false
145 ,p_effective_date in date
146 ,p_object_version_number in out nocopy number
147 );
148 --
149 -- ----------------------------------------------------------------------------
150 -- |---------------------------< delete_balance_type >------------------------|
151 -- ----------------------------------------------------------------------------
152 --
153 -- {Start Of Comments}
154 /*#
155 * This API deletes new backfeed balance type information.
156 *
157 *
158 * <p><b>Licensing</b><br>
159 * This API is licensed for use with Human Resources.
160 *
161 * <p><b>Prerequisites</b><br>
162 * A valid balance_type must already exist.
163 *
164 * <p><b>Post Success</b><br>
165 * The backfeed balance type amount will be successfully deleted from the
166 * database.
167 *
168 * <p><b>Post Failure</b><br>
169 * The backfeed balance type will not be deleted and an error will be raised.
170 * @param p_validate If true, then validation alone will be performed and the
171 * database will remain unchanged. If false and all validation checks pass,
172 * then the database will be modified.
173 * @param p_balance_type_id Balance_type to be deleted. If p_validate is false,
174 * uniquely identifies the balance_type to be deleted. If p_validate is true,
175 * set to null.
176 * @param p_object_version_number Current version number of the backfeed
177 * balance type to be deleted.
178 * @rep:displayname Delete Backfeed Balance Type
179 * @rep:category BUSINESS_ENTITY PER_BF_BALANCE
180 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
181 * @rep:scope public
182 * @rep:lifecycle active
183 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
184 */
185 --
186 -- {End Of Comments}
187 --
188 procedure delete_balance_type
189 (p_validate in boolean default false,
190 p_balance_type_id in number,
191 p_object_version_number in number
192 );
193 --
194 end per_bf_balance_types_api;
[Home] [Help]