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