1 Package hxc_alias_values_api as
2 /* $Header: hxchavapi.pkh 120.0 2005/05/29 05:34:57 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_alias_value >--------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This API creates an alias value.
11 --
12 -- Prerequisites:
13 -- An alias definition must exist, for which alias values will be created.
14 --
15 -- In Parameters:
16 -- Name Reqd Type Description
17 -- p_validate No boolean IF TRUE then the database
18 -- remains unchanged.IF FALSE
19 -- then a new alias value is
20 -- created. The default is FALSE.
21 -- p_alias_value_name Yes varchar2 The name for the alias value.
22 -- p_date_from Yes date The beginning date from which
23 -- this alias value is valid.
24 -- p_date_to No date The end date for this alias
25 -- value.
26 -- p_alias_definition_id Yes number The foreign key to the alias
27 -- definitions table. The alias
28 -- value belongs to this alias
29 -- definition.
30 -- p_enabled_flag Yes varchar2 This flag indicates whether
31 -- or not the alias value
32 -- will be visible on the list
33 -- of values on the timecard
34 -- field. 'Y' means it is
35 -- visible; 'N' means it is not.
36 -- p_attribute_category No varchar2 The flexfield context, for
37 -- the attribute columns.
38 -- p_attribute1..n No varchar2 Values for alias fields.
39 --
40 --
41 -- Post Success:
42 -- After the alias value has been created successfully, the following OUT
43 -- parameters are set:
44 --
45 -- Name Type Description
46 -- p_alias_value_id number Primary Key for entity
47 -- p_object_version_number number Object Version Number of the new
48 -- alias value record.
49 --
50 -- Post Failure:
51 -- The alias value is not created and an application error is raised.
52 --
53 -- Access Status:
54 -- Public.
55 --
56 -- {End Of Comments}
57 --
58 procedure create_alias_value
59 (p_validate in boolean default false
60 ,p_alias_value_id out nocopy number
61 ,p_alias_value_name in varchar2
62 ,p_date_from in date
63 ,p_date_to in date default null
64 ,p_alias_definition_id in number
65 ,p_enabled_flag in varchar2
66 ,p_attribute_category in varchar2 default null
67 ,p_attribute1 in varchar2 default null
68 ,p_attribute2 in varchar2 default null
69 ,p_attribute3 in varchar2 default null
70 ,p_attribute4 in varchar2 default null
71 ,p_attribute5 in varchar2 default null
72 ,p_attribute6 in varchar2 default null
73 ,p_attribute7 in varchar2 default null
74 ,p_attribute8 in varchar2 default null
75 ,p_attribute9 in varchar2 default null
76 ,p_attribute10 in varchar2 default null
77 ,p_attribute11 in varchar2 default null
78 ,p_attribute12 in varchar2 default null
79 ,p_attribute13 in varchar2 default null
80 ,p_attribute14 in varchar2 default null
81 ,p_attribute15 in varchar2 default null
82 ,p_attribute16 in varchar2 default null
83 ,p_attribute17 in varchar2 default null
84 ,p_attribute18 in varchar2 default null
85 ,p_attribute19 in varchar2 default null
86 ,p_attribute20 in varchar2 default null
87 ,p_attribute21 in varchar2 default null
88 ,p_attribute22 in varchar2 default null
89 ,p_attribute23 in varchar2 default null
90 ,p_attribute24 in varchar2 default null
91 ,p_attribute25 in varchar2 default null
92 ,p_attribute26 in varchar2 default null
93 ,p_attribute27 in varchar2 default null
94 ,p_attribute28 in varchar2 default null
95 ,p_attribute29 in varchar2 default null
96 ,p_attribute30 in varchar2 default null
97 ,p_object_version_number out nocopy number
98 ,p_language_code in varchar2 default hr_api.userenv_lang
99 );
100 --
101 -- ----------------------------------------------------------------------------
102 -- |--------------------------< update_alias_value >--------------------------|
103 -- ----------------------------------------------------------------------------
104 -- {Start Of Comments}
105 --
106 -- Description:
107 -- This API updates an existing alias value.
108 --
109 -- Prerequisites:
110 -- None.
111 --
112 -- In Parameters:
113 -- Name Reqd Type Description
114 -- p_validate No boolean IF TRUE then the database
115 -- remains unchanged.IF FALSE
116 -- then the alias value is
117 -- updated. The default is FALSE.
118 -- p_alias_value_id Yes number Primary Key for entity
119 -- p_alias_value_name Yes varchar2 The name for the alias value.
120 -- p_date_from Yes date The beginning date from which
121 -- this alias value is valid.
122 -- p_date_to No date The end date for this alias
123 -- value.
124 -- p_alias_definition_id Yes number The foreign key to the alias
125 -- definitions table. The alias
126 -- value belongs to this alias
127 -- definition.
128 -- p_enabled_flag Yes varchar2 This flag indicates whether
129 -- or not the alias value
130 -- will be visible on the list
131 -- of values on the timecard
132 -- field. 'Y' means it is
133 -- visible; 'N' means it is not.
134 -- p_attribute_category No varchar2 The flexfield context, for
135 -- the attribute columns.
136 -- p_attribute1..n No varchar2 Values for alias fields.
137 -- p_object_version_number No number Object Version Number of the
138 -- existing record.
139 --
140 --
141 -- Post Success:
142 -- After the alias value has been updated successfully, the following OUT
143 -- parameters are set:
144 --
145 -- Name Type Description
146 -- p_object_version_number number Object Version Number of the
147 -- updated alias value record.
148 --
149 -- Post Failure:
150 -- The alias value is not updated and an application error is raised.
151 --
152 -- Access Status:
153 -- Public.
154 --
155 -- {End Of Comments}
156 --
157 procedure update_alias_value
158 (p_validate in boolean default false
159 ,p_alias_value_id in number
160 ,p_alias_value_name in varchar2
161 ,p_date_from in date
162 ,p_date_to in date default null
163 ,p_alias_definition_id in number
164 ,p_enabled_flag in varchar2
165 ,p_attribute_category in varchar2 default null
166 ,p_attribute1 in varchar2 default null
167 ,p_attribute2 in varchar2 default null
168 ,p_attribute3 in varchar2 default null
169 ,p_attribute4 in varchar2 default null
170 ,p_attribute5 in varchar2 default null
171 ,p_attribute6 in varchar2 default null
172 ,p_attribute7 in varchar2 default null
173 ,p_attribute8 in varchar2 default null
174 ,p_attribute9 in varchar2 default null
175 ,p_attribute10 in varchar2 default null
176 ,p_attribute11 in varchar2 default null
177 ,p_attribute12 in varchar2 default null
178 ,p_attribute13 in varchar2 default null
179 ,p_attribute14 in varchar2 default null
180 ,p_attribute15 in varchar2 default null
181 ,p_attribute16 in varchar2 default null
182 ,p_attribute17 in varchar2 default null
183 ,p_attribute18 in varchar2 default null
184 ,p_attribute19 in varchar2 default null
185 ,p_attribute20 in varchar2 default null
186 ,p_attribute21 in varchar2 default null
187 ,p_attribute22 in varchar2 default null
188 ,p_attribute23 in varchar2 default null
189 ,p_attribute24 in varchar2 default null
190 ,p_attribute25 in varchar2 default null
191 ,p_attribute26 in varchar2 default null
192 ,p_attribute27 in varchar2 default null
193 ,p_attribute28 in varchar2 default null
194 ,p_attribute29 in varchar2 default null
195 ,p_attribute30 in varchar2 default null
196 ,p_object_version_number in out nocopy number
197 ,p_language_code in varchar2 default hr_api.userenv_lang
198 );
199 --
200 -- ----------------------------------------------------------------------------
201 -- |--------------------------< delete_alias_value >---------------------|
202 -- ----------------------------------------------------------------------------
203 -- {Start Of Comments}
204 --
205 -- Description:
206 -- This API deletes an existing alias value.
207 --
208 -- Prerequisites:
209 -- None.
210 --
211 -- In Parameters:
212 -- Name Reqd Type Description
213 -- p_validate No boolean If TRUE then the database
214 -- remains unchanged. If FALSE
215 -- then the alias value.
216 -- is deleted. Default is FALSE.
217 -- p_alias_value_id Yes number Primary Key for entity
218 -- p_object_version_number Yes number Object Version Number
219 --
220 -- Post Success:
221 --
222 -- If the alias value has been deleted successfully the process
223 -- completes with success, with no OUT parameters being set.
224 --
225 -- Post Failure:
226 --
227 -- The alias value will not be deleted and an application error is raised.
228 --
229 -- Access Status:
230 -- Public.
231 --
232 -- {End Of Comments}
233 --
234 procedure delete_alias_value
235 (p_validate in boolean default false
236 ,p_alias_value_id in number
237 ,p_object_version_number in number
238 );
239 --
240 end hxc_alias_values_api;
[Home] [Help]