1 Package pqh_dflt_fund_srcs_api as
2 /* $Header: pqdfsapi.pkh 120.1 2005/10/02 02:26:43 aroussel $ */
3 /*#
4 * This package contains APIs to create, update and delete the default funding
5 * source.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Default Funding Source
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_dflt_fund_src >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a default funding source.
18 *
19 * Cost allocation information for budget elements 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 element should already exist. Cost allocation flex or PTEAO
26 * information should already exist.
27 *
28 * <p><b>Post Success</b><br>
29 * Default funding source will be inserted in the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * Default funding source will not be created and an error will be raised.
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_dflt_fund_src_id If p_validate is false, then this uniquely
37 * identifies the default funding source created. If p_validate is true, then
38 * set to null.
39 * @param p_dflt_budget_element_id {@rep:casecolumn
40 * PQH_DFLT_FUND_SRCS.DFLT_BUDGET_ELEMENT_ID}
41 * @param p_dflt_dist_percentage {@rep:casecolumn
42 * PQH_DFLT_FUND_SRCS.DFLT_DIST_PERCENTAGE}
43 * @param p_project_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.PROJECT_ID}
44 * @param p_award_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.AWARD_ID}
45 * @param p_task_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.TASK_ID}
46 * @param p_expenditure_type {@rep:casecolumn
47 * PQH_DFLT_FUND_SRCS.EXPENDITURE_TYPE}
48 * @param p_organization_id {@rep:casecolumn
49 * PQH_DFLT_FUND_SRCS.ORGANIZATION_ID}
50 * @param p_object_version_number If p_validate is false, then set to the
51 * version number of the created default funding source. If p_validate is true,
52 * then the value will be null.
53 * @param p_cost_allocation_keyflex_id Cost allocation keyflex field
54 * identifier.
55 * @rep:displayname Create Default Funding Source
56 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
57 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
58 * @rep:scope public
59 * @rep:lifecycle active
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_dflt_fund_src
66 (
67 p_validate in boolean default false
68 ,p_dflt_fund_src_id out nocopy number
69 ,p_dflt_budget_element_id in number default null
70 ,p_dflt_dist_percentage in number default null
71 ,p_project_id in number default null
72 ,p_award_id in number default null
73 ,p_task_id in number default null
74 ,p_expenditure_type in varchar2 default null
75 ,p_organization_id in number default null
76 ,p_object_version_number out nocopy number
77 ,p_cost_allocation_keyflex_id in number default null
78 );
79 --
80 -- ----------------------------------------------------------------------------
81 -- |---------------------------< update_dflt_fund_src >-----------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API updates the default funding source.
87 *
88 * Cost allocation information for budget elements is updated.
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Human Resources.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The default funding source to be updated should already exist.
95 *
96 * <p><b>Post Success</b><br>
97 * Default funding source will be updated in the database.
98 *
99 * <p><b>Post Failure</b><br>
100 * Default funding Source will not be updated and an error will be raised.
101 * @param p_validate If true, then validation alone will be performed and the
102 * database will remain unchanged. If false and all validation checks pass,
103 * then the database will be modified.
104 * @param p_dflt_fund_src_id Identifies the default funding source.
105 * @param p_dflt_budget_element_id {@rep:casecolumn
106 * PQH_DFLT_FUND_SRCS.DFLT_BUDGET_ELEMENT_ID}
107 * @param p_dflt_dist_percentage {@rep:casecolumn
108 * PQH_DFLT_FUND_SRCS.DFLT_DIST_PERCENTAGE}
109 * @param p_project_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.PROJECT_ID}
110 * @param p_award_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.AWARD_ID}
111 * @param p_task_id {@rep:casecolumn PQH_DFLT_FUND_SRCS.TASK_ID}
112 * @param p_expenditure_type {@rep:casecolumn
113 * PQH_DFLT_FUND_SRCS.EXPENDITURE_TYPE}
114 * @param p_organization_id {@rep:casecolumn
115 * PQH_DFLT_FUND_SRCS.ORGANIZATION_ID}
116 * @param p_object_version_number Pass in the current version number of the
117 * default funding source to be updated. When the API completes if p_validate
118 * is false, will be set to the new version number of the updated default
119 * funding source. If p_validate is true will be set to the same value which
120 * was passed in.
121 * @param p_cost_allocation_keyflex_id Cost allocation keyflex field
122 * identifier.
123 * @rep:displayname Update Default Funding Source
124 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
125 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure update_dflt_fund_src
134 (
135 p_validate in boolean default false
136 ,p_dflt_fund_src_id in number
137 ,p_dflt_budget_element_id in number default hr_api.g_number
138 ,p_dflt_dist_percentage in number default hr_api.g_number
139 ,p_project_id in number default hr_api.g_number
140 ,p_award_id in number default hr_api.g_number
141 ,p_task_id in number default hr_api.g_number
142 ,p_expenditure_type in varchar2 default hr_api.g_varchar2
143 ,p_organization_id in number default hr_api.g_number
144 ,p_object_version_number in out nocopy number
145 ,p_cost_allocation_keyflex_id in number default hr_api.g_number
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |---------------------------< delete_dflt_fund_src >-----------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API deletes the default funding source.
155 *
156 * Cost allocation information for budget elements is deleted.
157 *
158 * <p><b>Licensing</b><br>
159 * This API is licensed for use with Human Resources.
160 *
161 * <p><b>Prerequisites</b><br>
162 * The default funding source to be deleted should already exist.
163 *
164 * <p><b>Post Success</b><br>
165 * Default funding source will be deleted from the database.
166 *
167 * <p><b>Post Failure</b><br>
168 * Default funding source will not be deleted and an error will be raised.
169 * @param p_validate If true, then validation alone will be performed and the
170 * database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_dflt_fund_src_id This uniquely identifies the default funding
173 * source.
174 * @param p_object_version_number Current version number of the default funding
175 * source to be deleted.
176 * @rep:displayname Delete Default Funding Source
177 * @rep:category BUSINESS_ENTITY PQH_DEFAULT_HR_BUDGET_SET
178 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
179 * @rep:scope public
180 * @rep:lifecycle active
181 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
182 */
183 --
184 -- {End Of Comments}
185 --
186 procedure delete_dflt_fund_src
187 (
188 p_validate in boolean default false
189 ,p_dflt_fund_src_id in number
190 ,p_object_version_number in number
191 );
192 --
193 --
194 end pqh_dflt_fund_srcs_api;
[Home] [Help]