1 Package pay_au_module_parameters_api as
2 /* $Header: pyampapi.pkh 120.1 2005/10/02 02:45 aroussel $ */
3 /*#
4 * This package contains module parameter APIs for Australia.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Module Parameters for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_au_module_parameter >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a module parameter for Australia.
17 *
18 * This API creates an entry on the table that lists the module parameters
19 * using for Australia Leave Liability process.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Payroll.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A module must be specified.
26 *
27 * <p><b>Post Success</b><br>
28 * The module parameter will be sucessfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The module parameter will not be created and an error will be raised.
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_module_id {@rep:casecolumn PAY_AU_MODULES.MODULE_ID}
37 * @param p_internal_name The internal name for the module parameter.
38 * @param p_data_type The data type for the module parameter.
39 * @param p_input_flag This flag indicates whether the module parameter is
40 * classified as an input parameter.
41 * @param p_context_flag This flag indicates whether the module parameter is
42 * classified as a context parameter.
43 * @param p_output_flag This flag indicates whether the module parameter is
44 * classified as a output parameter.
45 * @param p_result_flag This flag indicates whether the module parameter is
46 * classified as a result parameter.
47 * @param p_error_message_flag This flag indicates whether the module parameter
48 * is classified as a error message parameter.
49 * @param p_enabled_flag This flag indicates whether the module parameter is
50 * classified as enabled.
51 * @param p_function_return_flag This flag indicates whether the module
52 * parameter is classified as a function return parameter.
53 * @param p_external_name The external name for the module parameter.
54 * @param p_database_item_name The database item name for the module parameter.
55 * @param p_constant_value The constant value for the module parameter.
56 * @param p_module_parameter_id If p_validate is false, then this uniquely
57 * identifies the module parameter created. If p_validate is true, then set to
58 * null.
59 * @param p_object_version_number If p_validate is false, then set to the
60 * version number of the created module type. If p_validate is true, then the
61 * value will be null.
62 * @rep:displayname Create Module Parameter for Australia
63 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
64 * @rep:lifecycle active
65 * @rep:scope public
66 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
67 */
68 --
69 -- {End Of Comments}
70 --
71 procedure create_au_module_parameter
72 (p_validate in boolean default false,
73 p_module_id in number,
74 p_internal_name in varchar2,
75 p_data_type in varchar2,
76 p_input_flag in varchar2,
77 p_context_flag in varchar2,
78 p_output_flag in varchar2,
79 p_result_flag in varchar2,
80 p_error_message_flag in varchar2,
81 p_enabled_flag in varchar2,
82 p_function_return_flag in varchar2,
83 p_external_name in varchar2,
84 p_database_item_name in varchar2,
85 p_constant_value in varchar2,
86 p_module_parameter_id out nocopy number,
87 p_object_version_number out nocopy number );
88 --
89 -- ----------------------------------------------------------------------------
90 -- |------------------------< delete_au_module_parameter >--------------------|
91 -- ----------------------------------------------------------------------------
92 --
93 -- {Start Of Comments}
94 /*#
95 * This API deletes a module parameter record for Australia.
96 *
97 * This API deletes a row on the table that lists the module parameters using
98 * for Australia Leave Liability process.
99 *
100 * <p><b>Licensing</b><br>
101 * This API is licensed for use with Payroll.
102 *
103 * <p><b>Prerequisites</b><br>
104 * The module parameter should already exist.
105 *
106 * <p><b>Post Success</b><br>
107 * The API deletes the module parameter.
108 *
109 * <p><b>Post Failure</b><br>
110 * The API does not delete the module parameter and raises an error.
111 *
112 * @param p_validate If true, then validation alone will be performed and the
113 * database will remain unchanged. If false and all validation checks pass,
114 * then the database will be modified.
115 * @param p_module_parameter_id Unique identifier of the module parameter being
116 * deleted.
117 * @param p_object_version_number Current version number of the module
118 * parameter to be deleted.
119 * @rep:displayname Delete Module Parameter for Australia
120 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
121 * @rep:lifecycle active
122 * @rep:scope public
123 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
124 */
125 --
126 -- {End Of Comments}
127 --
128 procedure delete_au_module_parameter
129 (p_validate in boolean default false,
130 p_module_parameter_id in number,
131 p_object_version_number in number);
132 --
133 -- ----------------------------------------------------------------------------
134 -- |------------------------< update_au_module_parameter >--------------------|
135 -- ----------------------------------------------------------------------------
136 --
137 -- {Start Of Comments}
138 /*#
139 * This API updates a module parameter for Australia.
140 *
141 * This API updates a existing row on the table that lists the module
142 * parameters using for Australia Leave Liability process.
143 *
144 * <p><b>Licensing</b><br>
145 * This API is licensed for use with Payroll.
146 *
147 * <p><b>Prerequisites</b><br>
148 * The module parameter should already exist.
149 *
150 * <p><b>Post Success</b><br>
151 * The API updates the module parameter.
152 *
153 * <p><b>Post Failure</b><br>
154 * The API does not update the module parameter and raises an error.
155 *
156 * @param p_validate If true, then validation alone will be performed and the
157 * database will remain unchanged. If false and all validation checks pass,
158 * then the database will be modified.
159 * @param p_module_parameter_id Unique identifier of the module parameter being
160 * updated.
161 * @param p_module_id {@rep:casecolumn PAY_AU_MODULES.MODULE_ID}
162 * @param p_internal_name The internal name for the module parameter.
163 * @param p_data_type The data type for the module parameter.
164 * @param p_input_flag This flag indicates whether the module parameter is
165 * classified as an input parameter.
166 * @param p_context_flag This flag indicates whether the module parameter is
167 * classified as a context parameter.
168 * @param p_output_flag This flag indicates whether the module parameter is
169 * classified as a output parameter.
170 * @param p_result_flag This flag indicates whether the module parameter is
171 * classified as a result parameter.
172 * @param p_error_message_flag This flag indicates whether the module parameter
173 * is classified as a error message parameter.
174 * @param p_enabled_flag This flag indicates whether the module parameter is
175 * classified as enabled.
176 * @param p_function_return_flag This flag indicates whether the module
177 * parameter is classified as a function return parameter.
178 * @param p_external_name The external name for the module parameter.
179 * @param p_database_item_name The database item name for the module parameter.
180 * @param p_constant_value The constant value for the module parameter.
181 * @param p_object_version_number Pass in the current version number of the
182 * module parameter to be updated. When the API completes if p_validate is
183 * false, will be set to the new version number of the updated module
184 * parameter. If p_validate is true will be set to the same value which was
185 * passed in.
186 * @rep:displayname Update Module Parameter for Australia
187 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
188 * @rep:lifecycle active
189 * @rep:scope public
190 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
191 */
192 --
193 -- {End Of Comments}
194 --
195 procedure update_au_module_parameter
196 (p_validate in boolean default false,
197 p_module_parameter_id in number,
198 p_module_id in number,
199 p_internal_name in varchar2,
200 p_data_type in varchar2,
201 p_input_flag in varchar2,
202 p_context_flag in varchar2,
203 p_output_flag in varchar2,
204 p_result_flag in varchar2,
205 p_error_message_flag in varchar2,
206 p_enabled_flag in varchar2,
207 p_function_return_flag in varchar2,
208 p_external_name in varchar2,
209 p_database_item_name in varchar2,
210 p_constant_value in varchar2,
211 p_object_version_number in out nocopy number
212 );
213 --
214 --
215 end pay_au_module_parameters_api;
[Home] [Help]