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