1 Package pay_au_modules_api AUTHID CURRENT_USER as
2 /* $Header: pyamoapi.pkh 120.1 2005/10/02 02:45 aroussel $ */
3 /*#
4 * This package contains module APIs for Australia.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Modules for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------------< create_au_module >-------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a module for Australia.
17 *
18 * This API creates an entry on the table that lists the modules used for
19 * 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 business group for Australia legislation must be specified. A module type
26 * must be specified.
27 *
28 * <p><b>Post Success</b><br>
29 * The module will be sucessfully inserted into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The module will not be created and an error will be raised.
33 *
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_name The name for the module.
38 * @param p_enabled_flag This flag indicates whether the module is classified
39 * as enabled.
40 * @param p_module_type_id {@rep:casecolumn PAY_AU_MODULE_TYPES.MODULE_TYPE_ID}
41 * @param p_business_group_id The business group id for the module. It should
42 * be a valid business group for Australia.
43 * @param p_legislation_code The legislation code for the module. It should be
44 * 'AU'.
45 * @param p_description The description for the module.
46 * @param p_package_name The package name for the module.
47 * @param p_procedure_function_name The procedure function name for the module.
48 * @param p_formula_name The formula name for the module.
49 * @param p_module_id If p_validate is false, then this uniquely identifies the
50 * module created. If p_validate is true, then set to null.
51 * @param p_object_version_number If p_validate is false, then set to the
52 * version number of the created module. If p_validate is true, then the value
53 * will be null.
54 * @rep:displayname Create Module for Australia
55 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
56 * @rep:lifecycle active
57 * @rep:scope public
58 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
59 */
60 --
61 -- {End Of Comments}
62 --
63 procedure create_au_module
64 (p_validate in boolean default false,
65 p_name in varchar2,
66 p_enabled_flag in varchar2,
67 p_module_type_id in number,
68 p_business_group_id in number,
69 p_legislation_code in varchar2,
70 p_description in varchar2,
71 p_package_name in varchar2,
72 p_procedure_function_name in varchar2,
73 p_formula_name in varchar2,
74 p_module_id out nocopy number,
75 p_object_version_number out nocopy number );
76 --
77 -- ----------------------------------------------------------------------------
78 -- |-----------------------------< delete_au_module >-------------------------|
79 -- ----------------------------------------------------------------------------
80 --
81 -- {Start Of Comments}
82 /*#
83 * This API deletes a module record for Australia.
84 *
85 * This API deletes a row on the table that lists the modules used for
86 * Australia Leave Liability process. A module cannot be deleted if it is
87 * reference by a row in the table pay_au_process_modules or
88 * pay_au_module_parameters.
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Payroll.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The module should already exist.
95 *
96 * <p><b>Post Success</b><br>
97 * The API deletes the module.
98 *
99 * <p><b>Post Failure</b><br>
100 * The API does not delete the module and raises an error.
101 *
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_module_id Unique identifier of the module being deleted.
106 * @param p_object_version_number Current version number of the module to be
107 * deleted.
108 * @rep:displayname Delete Module for Australia
109 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
110 * @rep:lifecycle active
111 * @rep:scope public
112 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
113 */
114 --
115 -- {End Of Comments}
116 --
117 procedure delete_au_module
118 (p_validate in boolean default false,
119 p_module_id in number,
120 p_object_version_number in number);
121 --
122 -- ----------------------------------------------------------------------------
123 -- |-----------------------------< update_au_module >-------------------------|
124 -- ----------------------------------------------------------------------------
125 --
126 -- {Start Of Comments}
127 /*#
128 * This API updates a module for Australia.
129 *
130 * This API updates a existing row on the table that lists the modules used for
131 * Australia Leave Liability process.
132 *
133 * <p><b>Licensing</b><br>
134 * This API is licensed for use with Payroll.
135 *
136 * <p><b>Prerequisites</b><br>
137 * The module should already exist.
138 *
139 * <p><b>Post Success</b><br>
140 * The API updates the module.
141 *
142 * <p><b>Post Failure</b><br>
143 * The API does not update the module and raises an error.
144 *
145 * @param p_validate If true, then validation alone will be performed and the
146 * database will remain unchanged. If false and all validation checks pass,
147 * then the database will be modified.
148 * @param p_module_id Unique identifier of the module being updated.
149 * @param p_name The name for the module.
150 * @param p_enabled_flag This flag indicates whether the module is classified
151 * as enabled.
152 * @param p_module_type_id {@rep:casecolumn PAY_AU_MODULE_TYPES.MODULE_TYPE_ID}
153 * @param p_business_group_id The business group id for the module. It should
154 * be a valid business group for Australia.
155 * @param p_legislation_code The legislation code for the module, it should be
156 * 'AU'.
157 * @param p_description The description for the module.
158 * @param p_package_name The package name using for the module.
159 * @param p_procedure_function_name The procedure function name for the module.
160 * @param p_formula_name The formula name for the module.
161 * @param p_object_version_number Pass in the current version number of the
162 * module to be updated. When the API completes if p_validate is false, will be
163 * set to the new version number of the updated module. If p_validate is true
164 * will be set to the same value which was passed in.
165 * @rep:displayname Update Module for Australia
166 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
167 * @rep:lifecycle active
168 * @rep:scope public
169 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
170 */
171 --
172 -- {End Of Comments}
173 --
174 procedure update_au_module
175 (p_validate in boolean default false,
176 p_module_id in number,
177 p_name in varchar2,
178 p_enabled_flag in varchar2,
179 p_module_type_id in number,
180 p_business_group_id in number,
181 p_legislation_code in varchar2,
182 p_description in varchar2,
183 p_package_name in varchar2,
184 p_procedure_function_name in varchar2,
185 p_formula_name in varchar2,
186 p_object_version_number in out nocopy number
187 );
188 --
189 --
190 end pay_au_modules_api;
[Home] [Help]