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