1 Package FF_FUNCTIONS_API as
2 /* $Header: ffffnapi.pkh 120.1 2006/07/13 13:20:09 pgongada noship $ */
3 /*#
4 * This package is used to Create, Update and Delete Formula Function.
5 * @rep:scope public
6 * @rep:product pay
7 * @rep:displayname Formula Functions
8 */
9 -- ----------------------------------------------------------------------------
10 -- |-----------------------------< create_function >--------------------------|
11 -- ----------------------------------------------------------------------------
12 --
13 -- {Start Of Comments}
14 /*#
15 * This Business Process is used to create Formula Function.
16 *
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Oracle Payroll.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The specified business group, legislation code should exist.
23 *
24 * <p><b>Post Success</b><br>
25 * The Formula Function will be successfully Created in the database and
26 * all the out parameter will be set.
27 *
28 * <p><b>Post Failure</b><br>
29 * Error Messages will be raised if any business rule is violated and the
30 * Formula Function will not created.
31 *
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_name The name of the function.
39 * @param p_class Class of function determined by where it is defined.
40 * @param p_business_group_id Foreign key to HR_ORGANIZATION_UNITS.
41 * @param p_legislation_code Foreign key to FND_TERRITORIES.
42 * @param p_alias_name Alternative name for the function.
43 * @param p_data_type Data type of function or null for procedure.
44 * @param p_definition Name of the PL/SQL package and function stored in the
45 * database.
46 * @param p_description Description of the function.
47 * @param p_function_id Unique identifer for function.
48 * @param p_object_version_number If p_validate is false, then set to the
49 * version number of the created event procedure. If p_validate is true, then
50 * the value will be null.
51 * @rep:displayname Create Formula Function
52 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
53 * @rep:lifecycle active
54 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
55 * @rep:scope public
56 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
57 */
58 --
59 -- {End Of Comments}
60 --
61 procedure create_function
62 (p_validate in boolean default false
63 ,p_effective_date in date
64 ,p_name in varchar2
65 ,p_class in varchar2
66 ,p_business_group_id in number default null
67 ,p_legislation_code in varchar2 default null
68 ,p_alias_name in varchar2 default null
69 ,p_data_type in varchar2 default null
70 ,p_definition in varchar2 default null
71 ,p_description in varchar2 default null
72 ,p_function_id out nocopy number
73 ,p_object_version_number out nocopy number
74 );
75 --
76 -- ----------------------------------------------------------------------------
77 -- |-----------------------------< update_function >--------------------------|
78 -- ----------------------------------------------------------------------------
79 --
80 -- {Start Of Comments}
81 /*#
82 * This Business Process will be used to update Formula function.
83 *
84 * <p><b>Licensing</b><br>
85 * This API is licensed for use with Oracle Payroll
86 *
87 * <p><b>Prerequisites</b><br>
88 * The specified Formula Function should exist.
89 *
90 * <p><b>Post Success</b><br>
91 * The Formula Function will be successfully updated into the database and
92 * all the out parameter will be set.
93 *
94 * <p><b>Post Failure</b><br>
95 * Error Messages will be raised if any business rule is violated and the Formula
96 * Function will not updated.
97 *
98 * @param p_validate If true, then validation alone will be performed and the
99 * database will remain unchanged. If false and all validation checks pass,
100 * then the database will be modified.
101 * @param p_effective_date Reference date for validating lookup values are
102 * applicable during the start to end active date range. This date does not
103 * determine when the changes take effect.
104 * @param p_function_id Unique identifer for function
105 * @param p_object_version_number If p_validate is false, then set to the
106 * version number of the created event procedure. If p_validate is true, then
107 * the value will be null.
108 * @param p_name The name of the function.
109 * @param p_class Class of function determined by where it is defined.
110 * @param p_alias_name Alternative name for the function.
111 * @param p_data_type Data type of function or null for procedure.
112 * @param p_definition Name of the PL/SQL package and function stored in the
113 * database.
114 * @param p_description Description of the function.
115 * @rep:displayname Update Formula Function
116 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
117 * @rep:lifecycle active
118 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
119 * @rep:scope public
120 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
121 */
122 --
123 -- {End Of Comments}
124 --
125 procedure update_function
126 (p_validate in boolean default false
127 ,p_effective_date in date
128 ,p_function_id in number
129 ,p_object_version_number in out nocopy number
130 ,p_name in varchar2 default hr_api.g_varchar2
131 ,p_class in varchar2 default hr_api.g_varchar2
132 ,p_alias_name in varchar2 default hr_api.g_varchar2
133 ,p_data_type in varchar2 default hr_api.g_varchar2
134 ,p_definition in varchar2 default hr_api.g_varchar2
135 ,p_description in varchar2 default hr_api.g_varchar2
136 );
137 --
138 -- ----------------------------------------------------------------------------
139 -- |-----------------------------< delete_function >--------------------------|
140 -- ----------------------------------------------------------------------------
141 --
142 -- {Start Of Comments}
143 /*#
144 * This Business Process will be used to Delete Formula function.
145 *
146 * <p><b>Licensing</b><br>
147 * This API is licensed for use with Oracle Payroll.
148 *
149 * <p><b>Prerequisites</b><br>
150 * The specified Formula Function must exist.
151 *
152 * <p><b>Post Success</b><br>
153 * The Formula Function will be successfully deleted from the database.
154 *
155 * <p><b>Post Failure</b><br>
156 * Error Messages will be raised if any business rule is violated and the
157 * Formula Function will not deleted.
158 *
159 * @param p_validate If true, then validation alone will be performed and the
160 * database will remain unchanged. If false and all validation checks pass,
161 * then the database will be modified.
162 * @param p_function_id Unique identifer for function
163 * @param p_object_version_number If p_validate is false, then set to the
164 * version number of the created event procedure. If p_validate is true, then
165 * the value will be null.
166 * @rep:displayname Delete Formula Function
167 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
171 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
168 * @rep:lifecycle active
169 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
170 * @rep:scope public
172 */
173 --
174 -- {End Of Comments}
175 --
176 --
177 procedure delete_function
178 (p_validate in boolean default false
179 ,p_function_id in number
180 ,p_object_version_number in number
181 );
182 --
183
184 end FF_FUNCTIONS_API;
[Home] [Help]