1 Package ff_globals_api as
2 /* $Header: fffglapi.pkh 120.0.12010000.3 2008/10/31 12:26:02 pvelugul ship $ */
3 /*#
4 * This package contains the FF Global APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname FF Global
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_global >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a FF Global.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A valid Global identified by identified by p_global_id
24 * must exist. The p_business_group_id and
25 * p_legislation_code for this row must be consistent.
26 *
27 * <p><b>Post Success</b><br>
28 * The Global will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The Global 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_effective_date Determines when the DateTrack operation comes into
36 * force.
37 * @param p_global_name Global Name.
38 * @param p_global_description Global Description.
39 * @param p_value Stored value.
40 * @param p_data_type Data Type.
41 * @param p_business_group_id The global's business group.
42 * @param p_legislation_code The global's legislation.
43 * @param p_global_id If p_validate is false, this uniquely
44 * identifies the global created. If p_validate is true this
45 * parameter will be null.
46 * @param p_object_version_number If p_validate is false, then set to the
47 * version number of the created global. If p_validate is true,
48 * then the value will be null.
49 * @param p_effective_start_date If p_validate is false, then set to the
50 * earliest effective start date for the created global. If
51 * p_validate is true, then set to null.
52 * @param p_effective_end_date If p_validate is false, then set to the
53 * effective end date for the created global. If p_validate is
54 * true, then set to null.
55 * @rep:displayname Create Global
56 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
57 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:lifecycle active
61 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_global
67 (p_validate in boolean default false
68 ,p_effective_date in date
69 ,p_global_name in varchar2
70 ,p_global_description in varchar2
71 ,p_data_type IN varchar2
72 ,p_value in varchar2 default null
73 ,p_business_group_id in number default null
74 ,p_legislation_code in varchar2 default null
75 ,p_global_id out nocopy number
76 ,p_object_version_number out nocopy number
77 ,p_effective_start_date out nocopy date
78 ,p_effective_end_date out nocopy date
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |-------------------------------< update_global >--------------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates a global.
88 *
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 * A valid global identified by p_global_id and
95 * p_object_version_number must exist.
96 *
97 * <p><b>Post Success</b><br>
98 * The global will be successfully updated in the database.
99 *
100 * <p><b>Post Failure</b><br>
101 * The global will not be updated and an error will be raised.
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_effective_date Determines when the DateTrack operation comes into
106 * force
107 * @param p_global_id Identifier of global created.
108 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
109 * updating the record. You must set to either UPDATE, CORRECTION,
110 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
111 * particular record depend on the dates of previous record changes and the
112 * effective date of this change.
113 * @param p_value Stored value.
114 * @param p_object_version_number Pass in the current version number of the
115 * global to be updated. When the API completes if p_validate is
116 * false, will be set to the new version number of the updated global.
117 * If p_validate is true will be set to the same value which was
118 * passed in
119 * @param p_effective_start_date If p_validate is false, then set to the
120 * effective start date on the updated global row which now
121 * exists as of the effective date. If p_validate is true, then set to null.
122 * @param p_effective_end_date If p_validate is false, then set to the
123 * effective end date on the updated global row which now exists
124 * as of the effective date. If p_validate is true, then set to null.
125 * @rep:displayname Update Global
126 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
127 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
128 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
129 * @rep:scope public
130 * @rep:lifecycle active
131 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_global
137 (p_validate in boolean default false
138 ,p_effective_date in date
139 ,p_global_id in number
140 ,p_datetrack_update_mode in varchar2
141 ,p_value in varchar2 default HR_API.G_VARCHAR2
142 ,p_description in varchar2 default HR_API.G_VARCHAR2
143 ,p_object_version_number in out nocopy number
144 ,p_effective_start_date out nocopy date
145 ,p_effective_end_date out nocopy date
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |-------------------------------< delete_global >--------------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API deletes a global.
155 *
156 *
157 * <p><b>Licensing</b><br>
158 * This API is licensed for use with Human Resources.
159 *
160 * <p><b>Prerequisites</b><br>
161 * A valid global identified by p_global_id and
162 * p_object_version_number must exist.
163 *
164 * <p><b>Post Success</b><br>
165 * The global will have been successfully deleted from the
166 * database.
167 *
168 * <p><b>Post Failure</b><br>
169 * The global will not be deleted and an error will be raised.
170 * @param p_validate If true, then validation alone will be performed and the
171 * database will remain unchanged. If false and all validation checks pass,
172 * then the database will be modified.
173 * @param p_effective_date Determines when the DateTrack operation comes into
174 * force.
175 * @param p_global_id Unique identifier of the global record.
176 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
177 * updating the record. You must set to either UPDATE, CORRECTION,
178 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
179 * particular record depend on the dates of previous record changes and the
180 * effective date of this change.
181 * @param p_object_version_number Pass in the current version number of the
182 * global to be deleted. When the API completes if p_validate is
183 * false, will be set to the new version number of the deleted global.
184 * If p_validate is true will be set to the same value which was
185 * passed in.
186 * @param p_effective_start_date If p_validate is false, then set to the
187 * effective start date for the deleted global row which now
188 * exists as of the effective date. If p_validate is true or all row instances
189 * have been deleted then set to null.
190 * @param p_effective_end_date If p_validate is false, then set to the
191 * effective end date for the deleted global row which now exists
192 * as of the effective date. If p_validate is true or all row instances have
193 * been deleted then set to null.
194 * @rep:displayname Delete Global
195 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
196 * @rep:category MISC_EXTENSIONS HR_DATAPUMP
197 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
198 * @rep:scope public
199 * @rep:lifecycle active
200 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
201 */
202 --
203 -- {End Of Comments}
204 --
205 procedure delete_global
206 (p_validate in boolean default false
207 ,p_effective_date in date
208 ,p_global_id in number
209 ,p_datetrack_update_mode in varchar2
210 ,p_object_version_number in out nocopy number
211 ,p_effective_start_date out nocopy date
212 ,p_effective_end_date out nocopy date
213 );
214
215 --
216 end ff_globals_api;
[Home] [Help]