DBA Data[Home] [Help]

PACKAGE: APPS.HXC_BUILDING_BLOCK_API

Source


1 package hxc_building_block_api as
2 /* $Header: hxctbbapi.pkh 120.1 2005/07/14 17:18:24 arundell noship $ */
3 
4 -- ---------------------------------------------------------------------------
5 -- |-------------------< create_building_block >-----------------------------|
6 -- ---------------------------------------------------------------------------
7 -- {start of comments}
8 --
9 -- description
10 --   inserts a record into hxc_time_building_blocks
11 --
12 -- prerequisites
13 --
14 -- in parameters
15 --   name                      reqd?  type     description
16 --   p_validate                  y    boolean  if true,leaves database unchanged
17 --   p_effective_date            y    date     effective date of insert
18 --   p_type                      y    varchar2 building block type
19 --   p_measure                   n    number   measure of time unit
20 --   p_unit_of_measure           n    varchar2 time unit
21 --   p_start_time                n    date     time in
22 --   p_stop_time                 n    date     time out
23 --   p_parent_building_block_id  n    number   id of parent building block
24 --   p_parent_building_block_ovn n    number   ovn of parent building block
25 --   p_scope                     y    varchar2 scope of building block
26 --   p_approval_style_id         y    number   approval style id
27 --   p_approval_status           y    varchar2 approval status
28 --   p_resource_id               y    number   resource id
29 --   p_resource_type             y    varchar2 resource type
30 --   p_comment_text              n    varchar2 comments
31 --   p_application_set_id        n    number   application set Id of the TBB
32 --   p_translation_display_key   n    varchar2 Self Service display key
33 --
34 -- out parameters
35 --   name                       type      description
36 --   p_time_building_block_id   number    primary key
37 --   p_object_version_number    number    ovn
38 --
39 -- access status
40 --   public
41 --
42 -- {end of comments}
43 
44 procedure create_building_block
45   (p_validate                  in     boolean default false
46   ,p_effective_date            in     date
47   ,p_type                      in     varchar2
48   ,p_measure                   in     number
49   ,p_unit_of_measure           in     varchar2
50   ,p_start_time                in     date
51   ,p_stop_time                 in     date
52   ,p_parent_building_block_id  in     number
53   ,p_parent_building_block_ovn in     number
54   ,p_scope                     in     varchar2
55   ,p_approval_style_id         in     number
56   ,p_approval_status           in     varchar2
57   ,p_resource_id               in     number
58   ,p_resource_type             in     varchar2
59   ,p_comment_text              in     varchar2
60   ,p_application_set_id        in     number
61   ,p_translation_display_key   in     varchar2
62   ,p_time_building_block_id    in out nocopy number
63   ,p_object_version_number     in out nocopy number
64   );
65 
66 -- 115.11
67 -- New proc create_reversing_entry to have the DATE_TO parameter
68 -- ---------------------------------------------------------------------------
69 -- |-------------------< create_reversing_entry >-----------------------------|
70 -- ---------------------------------------------------------------------------
71 -- {start of comments}
72 --
73 -- description
74 --   inserts a record into hxc_time_building_blocks
75 --
76 -- prerequisites
77 --
78 -- in parameters
79 --   name                      reqd?  type     description
80 --   p_validate                  y    boolean  if true,leaves database unchanged
81 --   p_effective_date            y    date     effective date of insert
82 --   p_type                      y    varchar2 building block type
83 --   p_measure                   n    number   measure of time unit
84 --   p_unit_of_measure           n    varchar2 time unit
85 --   p_start_time                n    date     time in
86 --   p_stop_time                 n    date     time out
87 --   p_parent_building_block_id  n    number   id of parent building block
88 --   p_parent_building_block_ovn n    number   ovn of parent building block
89 --   p_scope                     y    varchar2 scope of building block
90 --   p_approval_style_id         y    number   approval style id
91 --   p_approval_status           y    varchar2 approval status
92 --   p_resource_id               y    number   resource id
93 --   p_resource_type             y    varchar2 resource type
94 --   p_comment_text              n    varchar2 comments
95 --   p_application_set_id        n    number   application set Id of the TBB
96 --   p_date_to                   y    date     end date for TBB
97 --   p_translation_display_key   n    varchar2 self service display key
98 --
99 -- out parameters
100 --   name                       type      description
101 --   p_time_building_block_id   number    primary key
102 --   p_object_version_number    number    ovn
103 --
104 -- access status
105 --   public
106 --
107 -- {end of comments}
108 
109 procedure create_reversing_entry
110   (p_validate                  in     boolean default false
111   ,p_effective_date            in     date
112   ,p_type                      in     varchar2
113   ,p_measure                   in     number
114   ,p_unit_of_measure           in     varchar2
115   ,p_start_time                in     date
116   ,p_stop_time                 in     date
117   ,p_parent_building_block_id  in     number
118   ,p_parent_building_block_ovn in     number
119   ,p_scope                     in     varchar2
120   ,p_approval_style_id         in     number
121   ,p_approval_status           in     varchar2
122   ,p_resource_id               in     number
123   ,p_resource_type             in     varchar2
124   ,p_comment_text              in     varchar2
125   ,p_application_set_id        in     number
126   ,p_date_to                   in     date
127   ,p_translation_display_key   in     varchar2
128   ,p_time_building_block_id    in out nocopy number
129   ,p_object_version_number     in out nocopy number
130   );
131 
132 
133 -- ---------------------------------------------------------------------------
134 -- |-------------------< update_building_block >-----------------------------|
135 -- ---------------------------------------------------------------------------
136 -- {start of comments}
137 --
138 -- description
139 --   updates a record in hxc_time_building_blocks (date enabled)
140 --
141 -- prerequisites
142 --
143 -- in parameters
144 --   name                      reqd?  type     description
145 --   p_validate                  y    boolean  if true,leaves database unchanged
146 --   p_time_building_block_id    y    number   primary key of record
147 --   p_effective_date            y    date     effective date of update
148 --   p_type                      y    varchar2 building block type
149 --   p_measure                   n    number   measure of time unit
150 --   p_unit_of_measure           n    varchar2 time unit
151 --   p_start_time                n    date     time in
152 --   p_stop_time                 n    date     ime out
153 --   p_parent_building_block_id  n    number   id of parent building block
154 --   p_parent_building_block_ovn n    number   ovn of parent building block
155 --   p_scope                     y    varchar2 scope of building block
156 --   p_approval_style_id         y    number   approval style id
157 --   p_approval_status           y    varchar2 approval status
158 --   p_resource_id               y    number   resource id
159 --   p_resource_type             y    varchar2 resource type
160 --   p_comment_text              n    varchar2 comments
161 --   p_application_set_id        n    number   application set Id of the TBB
162 --   p_translation_display_key   n    varchar2 self service display key
163 --
164 -- out parameters
165 --   name                       type      description
166 --   p_object_version_number    number    ovn
167 --
168 -- access status
169 --   public
170 --
171 -- {end of comments}
172 
173 procedure update_building_block
174   (p_validate                  in     boolean default false
175   ,p_effective_date            in     date
176   ,p_type                      in     varchar2
177   ,p_measure                   in     number
178   ,p_unit_of_measure           in     varchar2
179   ,p_start_time                in     date
180   ,p_stop_time                 in     date
181   ,p_parent_building_block_id  in     number
182   ,p_parent_building_block_ovn in     number
183   ,p_scope                     in     varchar2
184   ,p_approval_style_id         in     number
185   ,p_approval_status           in     varchar2
186   ,p_resource_id               in     number
187   ,p_resource_type             in     varchar2
188   ,p_comment_text              in     varchar2
189   ,p_time_building_block_id    in     number
190   ,p_application_set_id        in     number
191   ,p_translation_display_key   in     varchar2
192   ,p_object_version_number     in out nocopy number
193   );
194 
195 
196 -- ---------------------------------------------------------------------------
197 -- |-------------------< delete_building_block >-----------------------------|
198 -- ---------------------------------------------------------------------------
199 -- {start of comments}
200 --
201 -- description
202 --   deletes a record from hxc_time_building_blocks (date enabled)
203 --
204 -- prerequisites
205 --
206 -- in parameters
207 --   name                   reqd?   type     description
208 --   p_validate               y     boolean  if true, leaves database unchanged
209 --   p_object_version_number  y     number   object_version_number
210 --   p_time_building_block_id y     number   primary key of record
211 --   p_effective_date         y     date     effective date
212 --
213 -- out parameters
214 --   name                       type      description
215 --   p_object_version_number    number    ovn
216 --
217 -- access status
218 --   public
219 --
220 -- {end of comments}
221 
222 procedure delete_building_block
223   (p_validate               in     boolean default false
224   ,p_object_version_number  in out nocopy number
225   ,p_time_building_block_id in     number
226   ,p_effective_date         in     date
227   ,p_application_set_id     in     number default null
228   );
229 
230 end hxc_building_block_api;