1 package hxc_time_attributes_api AUTHID CURRENT_USER as
2 /* $Header: hxctatapi.pkh 115.16 2003/11/20 09:11:53 arundell noship $ */
3
4 type time_attribute is record
5 (attribute_name varchar2(35)
6 ,attribute_value varchar2(150)
7 ,information_type varchar2(80)
8 ,column_name varchar2(80)
9 ,info_mapping_type varchar2(150)
10 );
11
12 type timecard is table of time_attribute index by binary_integer;
13
14 type info_type_table is table of varchar2(80) index by binary_integer;
15
16 -- ---------------------------------------------------------------------------
17 -- |---------------------< create_attributes >-------------------------------|
18 -- ---------------------------------------------------------------------------
19 -- {Start of Comments}
20 --
21 -- Description:
22 -- Inserts new rows into hxc_time_attributes. This interface should be
23 -- used when more than one attribute is to be created.
24 --
25 -- Prerequisites:
26 -- The building blocks specified by the time_building_block_id component
27 -- of the timecard structure, must exist in the hxc_time_building_blocks
28 -- table, if this value is not null.
29 --
30 -- In Parameters:
31 -- Name Reqd? Type Description
32 -- p_validate y boolean if true, leaves database unchanged
33 -- p_timecard y timecard pl/sql table of attributes
34 -- p_process_id n number deposit process id
35 -- p_time_building_block_id n varchar2 id of parent time building block
36 -- p_tbb_ovn n number ovn of parent time building block
37 --
38 -- Out Parameters:
39 -- Name Type Description
40 -- p_time_attribute_id number primary key
41 -- p_object_version_number number object version number
42 --
43 -- Post Success:
44 -- The time attributes are created, and the API sets the
45 -- following out parameters:
46 --
47 -- Name Type Description
48 -- p_time_attribute_id number Unique ID for the attribute
49 -- created.
50 -- p_object_version_number number The version of the attribute
51 -- record - always 1 using
52 -- this interface.
53 --
54 -- Post Failure:
55 -- The API does not create the time attribute, and raises an error.
56 --
57 -- Access Status:
58 -- Internal Development Use Only.
59 --
60 -- {End of Comments}
61
62 procedure create_attributes
63 (p_validate in boolean default false
64 ,p_timecard in timecard
65 ,p_process_id in number
66 ,p_time_building_block_id in number
67 ,p_tbb_ovn in number
68 ,p_time_attribute_id in out nocopy number
69 ,p_object_version_number in out nocopy number
70 );
71
72 -- ---------------------------------------------------------------------------
73 -- |----------------------< create_attribute >-------------------------------|
74 -- ---------------------------------------------------------------------------
75 -- {Start of Comments}
76 --
77 -- Description:
78 -- Inserts a new row into the hxc_time_attributes table. This interface
79 -- should be used when only one attribute will be created.
80 --
81 -- Prerequisites:
82 -- If not null, the building block specified by p_time_building_block_id
83 -- and p_tbb_ovn must exist in the hxc_time_building_blocks table.
84 --
85 -- In Parameters:
86 -- Name Reqd? Type Description
87 -- p_validate y boolean if true, leaves database
88 -- unchanged
89 -- p_bld_blk_info_type_id y number id of the building block
90 -- information type
91 -- p_attribute_category n varchar2 standard flex column
92 -- p_attribute1 n varchar2 standard flex column
93 -- p_attribute2 n varchar2 standard flex column
94 -- p_attribute3 n varchar2 standard flex column
95 -- p_attribute4 n varchar2 standard flex column
96 -- p_attribute5 n varchar2 standard flex column
97 -- p_attribute6 n varchar2 standard flex column
98 -- p_attribute7 n varchar2 standard flex column
99 -- p_attribute8 n varchar2 standard flex column
100 -- p_attribute9 n varchar2 standard flex column
101 -- p_attribute10 n varchar2 standard flex column
102 -- p_attribute11 n varchar2 standard flex column
103 -- p_attribute12 n varchar2 standard flex column
104 -- p_attribute13 n varchar2 standard flex column
105 -- p_attribute14 n varchar2 standard flex column
106 -- p_attribute15 n varchar2 standard flex column
107 -- p_attribute16 n varchar2 standard flex column
108 -- p_attribute17 n varchar2 standard flex column
109 -- p_attribute18 n varchar2 standard flex column
110 -- p_attribute19 n varchar2 standard flex column
111 -- p_attribute20 n varchar2 standard flex column
112 -- p_attribute21 n varchar2 standard flex column
113 -- p_attribute22 n varchar2 standard flex column
114 -- p_attribute23 n varchar2 standard flex column
115 -- p_attribute24 n varchar2 standard flex column
116 -- p_attribute25 n varchar2 standard flex column
117 -- p_attribute26 n varchar2 standard flex column
118 -- p_attribute27 n varchar2 standard flex column
119 -- p_attribute28 n varchar2 standard flex column
120 -- p_attribute29 n varchar2 standard flex column
121 -- p_attribute30 n varchar2 standard flex column
122 -- p_time_building_block_id n varchar2 id of corresponding time
123 -- building block
124 -- p_tbb_ovn n number ovn of coresponding time
125 -- building block
126 --
127 -- Out Parameters:
128 -- name type description
129 -- p_time_attribute_id number primary key
130 -- p_object_version_number number object version number
131 --
132 -- Post Success:
133 -- The time attribute is created, and the API sets the
134 -- following out parameters:
135 --
136 -- Name Type Description
137 -- p_time_attribute_id number Unique ID for the attribute
138 -- created.
139 -- p_object_version_number number The version of the attribute
140 -- record - always 1 using
141 -- this interface.
142 --
143 -- Post Failure:
144 -- The API does not create the time attribute, and raises an error.
145 --
146 -- Access Status:
147 -- Internal Development Use Only
148 --
149 -- {End of Comments}
150
151 procedure create_attribute
152 (p_validate in boolean default false
153 ,p_bld_blk_info_type_id in number
154 ,p_attribute_category in varchar2
155 ,p_attribute1 in varchar2
156 ,p_attribute2 in varchar2
157 ,p_attribute3 in varchar2
158 ,p_attribute4 in varchar2
159 ,p_attribute5 in varchar2
160 ,p_attribute6 in varchar2
161 ,p_attribute7 in varchar2
162 ,p_attribute8 in varchar2
163 ,p_attribute9 in varchar2
164 ,p_attribute10 in varchar2
165 ,p_attribute11 in varchar2
166 ,p_attribute12 in varchar2
167 ,p_attribute13 in varchar2
168 ,p_attribute14 in varchar2
169 ,p_attribute15 in varchar2
170 ,p_attribute16 in varchar2
171 ,p_attribute17 in varchar2
172 ,p_attribute18 in varchar2
173 ,p_attribute19 in varchar2
174 ,p_attribute20 in varchar2
175 ,p_attribute21 in varchar2
176 ,p_attribute22 in varchar2
177 ,p_attribute23 in varchar2
178 ,p_attribute24 in varchar2
179 ,p_attribute25 in varchar2
180 ,p_attribute26 in varchar2
181 ,p_attribute27 in varchar2
182 ,p_attribute28 in varchar2
183 ,p_attribute29 in varchar2
184 ,p_attribute30 in varchar2
185 ,p_time_building_block_id in number
186 ,p_tbb_ovn in number
187 ,p_time_attribute_id in out nocopy number
188 ,p_object_version_number in out nocopy number
189 );
190
191 -- ---------------------------------------------------------------------------
192 -- |---------------------< update_attributes >-------------------------------|
193 -- ---------------------------------------------------------------------------
194 -- {Start of Comments}
195 --
196 -- Description:
197 -- updates attribute definitions related to a building_block
198 --
199 -- Prerequisites:
200 --
201 -- In Parameters:
202 -- Name Reqd? Type Description
203 -- p_validate y boolean if true, leaves database unchanged
204 -- p_timecard y timecard pl/sql table of attributes
205 -- p_process_id y number deposit process id
206 -- p_time_building_block_id y varchar2 id of parent time building block
207 --
208 -- Out Parameters:
209 -- name type Description
210 -- p_object_version_number number object version number
211 --
212 -- Post Success:
213 -- The time attributes are updated, and the API sets the
214 -- following out parameter:
215 --
216 -- Name Type Description
217 -- p_object_version_number number The new version number
218 -- of the attribute record
219 --
220 -- Post Failure:
221 -- The time attributes are not updated, and the API raises an error.
222 --
223 -- Access Status:
224 -- Internal Development Use Only.
225 --
226 -- {End of Comments}
227
228 procedure update_attributes
229 (p_validate in boolean default false
230 ,p_timecard in timecard
231 ,p_process_id in number
232 ,p_time_building_block_id in number
233 ,p_time_attribute_id in number
234 ,p_object_version_number in out nocopy number
235 );
236
237
238 -- ---------------------------------------------------------------------------
239 -- |---------------------< delete_attributes >-------------------------------|
240 -- ---------------------------------------------------------------------------
241 -- {Start of Comments}
242 --
243 -- Description:
244 -- deletes attribute definitions related to a building_block
245 --
246 -- Prerequisites:
247 --
248 -- In Parameters:
249 -- Name Reqd? Type Description
250 -- p_validate y boolean if true, leaves database unchanged
251 -- p_time_attribute_id y number primary key of record
252 --
253 -- Out Parameters:
254 -- Name Type Description
255 --
256 -- Post Success:
257 -- The time attribute specified by p_time_attribute_id is deleted.
258 --
259 -- Post Failure:
260 -- The time attribute is not deleted, and the API raises an error.
261 --
262 -- Access Status:
263 -- Internal Development Use Only
264 --
265 -- {End of Comments}
266
267 procedure delete_attributes
268 (p_validate in boolean default false
269 ,p_time_attribute_id in number
270 ,p_object_version_number in number
271 );
272
273
274 end hxc_time_attributes_api;
[Home] [Help]