1 Package pay_au_process_parameters_api AUTHID CURRENT_USER as
2 /* $Header: pyappapi.pkh 120.1 2005/10/02 02:45 aroussel $ */
3 /*#
4 * This package contains process parameter APIs for Australia.
5 * @rep:scope public
6 * @rep:product PAY
7 * @rep:displayname Process Parameters for Australia
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_au_process_parameter >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a process parameter for Australia.
17 *
18 * This API creates an entry on the table that lists the process 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 process must be specified.
26 *
27 * <p><b>Post Success</b><br>
28 * The process parameter will be sucessfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The process 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_process_id {@rep:casecolumn PAY_AU_PROCESSES.PROCESS_ID}
37 * @param p_internal_name The internal name for the process parameter.
38 * @param p_data_type The data type for the process parameter.
39 * @param p_enabled_flag This flag indicates whether the process parameter is
40 * classified as enabled.
41 * @param p_process_parameter_id If p_validate is false, then this uniquely
42 * identifies the process parameter 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 parameter. If p_validate is true, then
46 * the value will be null.
47 * @rep:displayname Create Process Parameter 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_parameter
57 (p_validate in boolean default false,
58 p_process_id in number,
59 p_internal_name in varchar2,
60 p_data_type in varchar2,
61 p_enabled_flag in varchar2,
62 p_process_parameter_id out nocopy number,
63 p_object_version_number out nocopy number );
64 --
65 -- ----------------------------------------------------------------------------
66 -- |-----------------------< delete_au_process_parameter >--------------------|
67 -- ----------------------------------------------------------------------------
68 --
69 -- {Start Of Comments}
70 /*#
71 * This API deletes a process parameter record for Australia.
72 *
73 * This API deletes a row on the table that lists the process parameters using
74 * for 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 parameter should already exist.
81 *
82 * <p><b>Post Success</b><br>
83 * The API deletes the process parameter.
84 *
85 * <p><b>Post Failure</b><br>
86 * The API does not delete the process parameter 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_parameter_id Unique identifier of the process parameter
92 * being deleted.
93 * @param p_object_version_number Current version number of the process
94 * parameter to be deleted.
95 * @rep:displayname Delete Process Parameter 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_parameter
105 (p_validate in boolean default false,
106 p_process_parameter_id in number,
107 p_object_version_number in number);
108 --
109 -- ----------------------------------------------------------------------------
110 -- |-----------------------< update_au_process_parameter >--------------------|
111 -- ----------------------------------------------------------------------------
112 --
113 -- {Start Of Comments}
114 /*#
115 * This API updates a process parameter record for Australia.
116 *
117 * This API updates a existing row on the table that lists the process
118 * parameters 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 parameter should already exist.
125 *
126 * <p><b>Post Success</b><br>
127 * The API updates the process parameter.
128 *
129 * <p><b>Post Failure</b><br>
130 * The API does not update the process parameter 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_parameter_id Unique identifier of the process parameter
136 * being updated.
137 * @param p_process_id {@rep:casecolumn PAY_AU_PROCESSES.PROCESS_ID}
138 * @param p_internal_name The internal name for the process parameter.
139 * @param p_data_type The data type for the process parameter.
140 * @param p_enabled_flag This flag indicates whether the process parameter is
141 * classified as enabled.
142 * @param p_object_version_number Pass in the current version number of the
143 * process parameter to be updated. When the API completes if p_validate is
144 * false, will be set to the new version number of the updated process
145 * parameter. If p_validate is true will be set to the same value which was
146 * passed in.
147 * @rep:displayname Update Process Parameter for Australia
148 * @rep:category BUSINESS_ENTITY PAY_LEAVE_LIABILITY
149 * @rep:lifecycle active
150 * @rep:scope public
151 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
152 */
153 --
154 -- {End Of Comments}
155 --
156 procedure update_au_process_parameter
157 (p_validate in boolean default false,
158 p_process_parameter_id in number,
159 p_process_id in number,
160 p_internal_name IN varchar2,
161 p_data_type IN varchar2,
162 p_enabled_flag IN varchar2,
163 p_object_version_number in out nocopy number
164 );
165 --
166 --
167 end pay_au_process_parameters_api;
[Home] [Help]