1 Package pqh_dflt_budget_elements_api as
2 /* $Header: pqdelapi.pkh 120.1 2005/10/02 02:26:38 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the default budget
5 * elements.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Default Budget Element
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------< create_dflt_budget_element >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the default budget elements.
18 *
19 * Budget elements for default budget set is created.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human Resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * Default budget set should already exist.
26 *
27 * <p><b>Post Success</b><br>
28 * Default budget element will be inserted in the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * Default budget element will not be created and an error will be raised.
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_dflt_budget_element_id If p_validate is false, then this uniquely
36 * identifies the default budget element record created. If p_validate is true,
37 * then set to null.
38 * @param p_dflt_budget_set_id {@rep:casecolumn
39 * PQH_DFLT_BUDGET_ELEMENTS.DFLT_BUDGET_SET_ID}
40 * @param p_element_type_id {@rep:casecolumn
41 * PQH_DFLT_BUDGET_ELEMENTS.ELEMENT_TYPE_ID}
42 * @param p_dflt_dist_percentage {@rep:casecolumn
43 * PQH_DFLT_BUDGET_ELEMENTS.DFLT_DIST_PERCENTAGE}
44 * @param p_object_version_number If p_validate is false, then set to the
45 * version number of the created default budget element. If p_validate is true,
46 * then the value will be null.
47 * @rep:displayname Create Default Budget Element
48 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
49 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
50 * @rep:scope public
51 * @rep:lifecycle active
52 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
53 */
54 --
55 -- {End Of Comments}
56 --
57 procedure create_dflt_budget_element
58 (
59 p_validate in boolean default false
60 ,p_dflt_budget_element_id out nocopy number
61 ,p_dflt_budget_set_id in number default null
62 ,p_element_type_id in number default null
63 ,p_dflt_dist_percentage in number default null
64 ,p_object_version_number out nocopy number
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |------------------------< update_dflt_budget_element >--------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 /*#
73 * This API updates the default budget element.
74 *
75 * Budget element for a default budget set is updated.
76 *
77 * <p><b>Licensing</b><br>
78 * This API is licensed for use with Human Resources.
79 *
80 * <p><b>Prerequisites</b><br>
81 * The budget element to be updated should already exist. Default budget set
82 * should already exist.
83 *
84 * <p><b>Post Success</b><br>
85 * Default budget element will be updated in the database.
86 *
87 * <p><b>Post Failure</b><br>
88 * Default budget element will not be updated and an error will be raised.
89 * @param p_validate If true, then validation alone will be performed and the
90 * database will remain unchanged. If false and all validation checks pass,
91 * then the database will be modified.
92 * @param p_dflt_budget_element_id Identifies the default budget element.
93 * @param p_dflt_budget_set_id {@rep:casecolumn
94 * PQH_DFLT_BUDGET_ELEMENTS.DFLT_BUDGET_SET_ID}
95 * @param p_element_type_id {@rep:casecolumn
96 * PQH_DFLT_BUDGET_ELEMENTS.ELEMENT_TYPE_ID}
97 * @param p_dflt_dist_percentage {@rep:casecolumn
98 * PQH_DFLT_BUDGET_ELEMENTS.DFLT_DIST_PERCENTAGE}
99 * @param p_object_version_number Pass in the current version number of the
100 * default budget element to be updated. When the API completes if p_validate
101 * is false, will be set to the new version number of the updated default
102 * budget element. If p_validate is true will be set to the same value which
103 * was passed in.
104 * @rep:displayname Update Default Budget Element
105 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 * @rep:lifecycle active
109 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
110 */
111 --
112 -- {End Of Comments}
113 --
114 procedure update_dflt_budget_element
115 (
116 p_validate in boolean default false
117 ,p_dflt_budget_element_id in number
118 ,p_dflt_budget_set_id in number default hr_api.g_number
119 ,p_element_type_id in number default hr_api.g_number
120 ,p_dflt_dist_percentage in number default hr_api.g_number
121 ,p_object_version_number in out nocopy number
122 );
123 --
124 -- ----------------------------------------------------------------------------
125 -- |------------------------< delete_dflt_budget_element >--------------------|
126 -- ----------------------------------------------------------------------------
127 --
128 -- {Start Of Comments}
129 /*#
130 * This API deletes the default budget element.
131 *
132 * Budget element for a default budget set is deleted.
133 *
134 * <p><b>Licensing</b><br>
135 * This API is licensed for use with Human Resources.
136 *
137 * <p><b>Prerequisites</b><br>
138 * The budget element to be deleted should already exist.
139 *
140 * <p><b>Post Success</b><br>
141 * Default budget element will be deleted from the database.
142 *
143 * <p><b>Post Failure</b><br>
144 * Default budget element will not be deleted and an error will be raised.
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_dflt_budget_element_id This uniquely identifies the default budget
149 * element.
150 * @param p_object_version_number Current version number of the default budget
151 * element to be deleted.
152 * @rep:displayname Delete Default Budget Element
153 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
154 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
155 * @rep:scope public
156 * @rep:lifecycle active
157 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
158 */
159 --
160 -- {End Of Comments}
161 --
162 procedure delete_dflt_budget_element
163 (
164 p_validate in boolean default false
165 ,p_dflt_budget_element_id in number
166 ,p_object_version_number in number
167 );
168 --
169 end pqh_dflt_budget_elements_api;
[Home] [Help]