1 Package FF_FUNCTION_PARAMETERS_API as
2 /* $Header: ffffpapi.pkh 120.1 2006/07/13 13:14:11 pgongada noship $ */
3 /*#
4 * This package is used to Create, Update and Delete the parameters
5 * of a Formula Function.
6 * @rep:scope public
7 * @rep:product pay
8 * @rep:displayname Parameters of a Formula Function
9 */
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_parameter >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This Business Process is used to insert definitions for the parameters
17 * of a specific Formula function.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Oracle Payroll.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The specified Formula Function should exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Formula Function Parameter will be successfully inserted into the
27 * database and all the out parameter will be set.
28 *
29 * <p><b>Post Failure</b><br>
30 * The Formula Function Parameter will not be created and appropriate error
31 * message wiil be prompted.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_function_id Foreign key to FF_FUNCTIONS.
40 * @param p_class Identifies whether the parameter is an IN parameter, an OUT
41 * parameter, or an IN-OUT parameter.
42 * @param p_data_type Data type of the parameter.
43 * @param p_name Name of the parameter.
44 * @param p_optional 'N' if the parameter is mandatory, else Y.
45 * @param p_continuing_parameter Y if there can be one or more of the
46 * parameter, else N.
47 * @param p_sequence_number Part of primary key. Identifies Number for each
48 * parameter in a specific sequence.
49 * @param p_object_version_number If p_validate is false, then set to the
50 * version number of the created event procedure. If p_validate is true, then
51 * the value will be null.
52 * @rep:displayname Create Parameter For A Formula Function
53 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
54 * @rep:lifecycle active
55 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
56 * @rep:scope public
57 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
58 */
59 --
60 -- {End Of Comments}
61
62 procedure create_parameter
63 (p_validate in boolean default false
64 ,p_effective_date in date
65 ,p_function_id in number
66 ,p_class in varchar2
67 ,p_data_type in varchar2
68 ,p_name in varchar2
69 ,p_optional in varchar2 default 'N'
70 ,p_continuing_parameter in varchar2 default 'N'
71 ,p_sequence_number out nocopy number
72 ,p_object_version_number out nocopy number
73 );
74 -- ----------------------------------------------------------------------------
75 -- |-----------------------------< update_parameter >-------------------------|
76 -- ----------------------------------------------------------------------------
77 --
78 -- {Start Of Comments}
79 /*#
80 * This Business Process is used to update definitions of the parameters
81 * of a specific Formula function.
82 *
83 * <p><b>Licensing</b><br>
84 * This API is licensed for use with Oracle Payroll.
85 *
86 * <p><b>Prerequisites</b><br>
87 * The parameters of a specific Formula function to be updated should exist.
88 * The Formula Function is specified, then it should exist.
89 *
90 * <p><b>Post Success</b><br>
91 * The Formula Function Parameter will be successfully updated into the
92 * database and all the out parameter will be set.
93 *
94 * <p><b>Post Failure</b><br>
95 * The Formula Function Parameter will not be updated and appropriate error
96 * message wiil be prompted.
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 Foreign key to FF_FUNCTIONS.
105 * @param p_sequence_number Part of primary key. Identifies Number for each
106 * parameter in a specific sequence.
107 * @param p_object_version_number If p_validate is false, then set to the
108 * version number of the created event procedure. If p_validate is true, then
109 * the value will be null.
110 * @param p_class Identifies whether the parameter is an IN parameter,an OUT
111 * parameter, or an IN-OUT parameter.
112 * @param p_data_type Data type of the parameter.
113 * @param p_name Name of the parameter.
114 * @param p_optional 'N' if the parameter is mandatory, else Y.
115 * @param p_continuing_parameter 'Y' if there can be one or more of the
116 * parameter, else 'N'.
117 * @rep:displayname Update Parameter Of a Formula Function.
118 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
119 * @rep:lifecycle active
120 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
121 * @rep:scope public
122 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
123 */
124 --
125 -- {End Of Comments}
126 --
127 procedure update_parameter
128 (p_validate in boolean default false
129 ,p_effective_date in date
130 ,p_function_id in number
131 ,p_sequence_number in number
132 ,p_object_version_number in out nocopy number
133 ,p_class in varchar2 default hr_api.g_varchar2
134 ,p_data_type in varchar2 default hr_api.g_varchar2
135 ,p_name in varchar2 default hr_api.g_varchar2
136 ,p_optional in varchar2 default hr_api.g_varchar2
137 ,p_continuing_parameter in varchar2 default hr_api.g_varchar2
138 );
139 -- ----------------------------------------------------------------------------
140 -- |-----------------------------< delete_parameter >-------------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 /*#
145 * This Business Process is used to delete definitions of the parameters
146 * of a specific Formula function.
147 *
148 * <p><b>Licensing</b><br>
149 * This API is licensed for use with Oracle Payroll
150 *
151 * <p><b>Prerequisites</b><br>
152 * The parameters of a specific Formula function to be deleted should exist.
153 *
154 * <p><b>Post Success</b><br>
155 * Specified Parameter of the Formula Function will be deleted.
156 *
157 * <p><b>Post Failure</b><br>
158 * Error Messages will be raised if any business rule is violated and the
159 * Formula Function Parameter will not be deleted.
160 *
161 * @param p_validate If true, then validation alone will be performed and the
162 * database will remain unchanged. If false and all validation checks pass,
163 * then the database will be modified.
164 * @param p_function_id Foreign key to FF_FUNCTIONS.
165 * @param p_sequence_number Part of primary key. Identifies Number for each
166 * parameter in a specific sequence.
167 * @param p_object_version_number If p_validate is false, then set to the
168 * version number of the created event procedure. If p_validate is true, then
169 * the value will be null.
170 * @rep:displayname Delete Parameter Of A Formula Function
171 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
172 * @rep:lifecycle active
173 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
174 * @rep:scope public
175 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
176 */
177 --
178 -- {End Of Comments}
179 --
180 procedure delete_parameter
181 (p_validate in boolean default false
182 ,p_function_id in number
183 ,p_sequence_number in number
184 ,p_object_version_number in number
185 );
186
187 --
188 end FF_FUNCTION_PARAMETERS_API;
[Home] [Help]