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