1 Package hxc_time_category_api as
2 /* $Header: hxchtcapi.pkh 120.0.12010000.5 2009/01/07 12:08:56 asrajago ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------< create_time_category >-----------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- {Start Of Comments}
9 --
10 -- Description:
11 --
12 -- This API creates a field mapping with a given name
13 --
14 -- Prerequisites:
15 --
16 -- None
17 --
18 -- In Parameters:
19 -- Name Reqd Type Description
20 --
21 -- p_validate No boolean If TRUE then the database
22 -- remains unchanged. If FALSE
23 -- then a new time category
24 -- is created. Default is FALSE.
25 -- p_time_category_id No number Primary Key for entity
26 -- p_object_version_number No number Object Version Number
27 -- p_time_category_name Yes varchar2 time category name
28 -- p_operator Yes varchar2 the operator to act upon the
29 -- TC components
30 --
31 -- Post Success:
32 --
33 -- when the mapping has been created successfully the following
34 -- out parameters are set.
35 --
36 -- Name Type Description
37 --
38 -- p_time_category_id Number Primary Key for the time category
39 -- p_object_version_number Number Object version number for the
40 -- new time category
41 --
42 -- Post Failure:
43 --
44 -- The mapping will not be inserted and an application error raised
45 --
46 -- Access Status:
47 -- Public.
48 --
49 -- {End Of Comments}
50 --
51 procedure create_time_category
52 (p_validate in boolean default false
53 ,p_time_category_id in out nocopy number
54 ,p_object_version_number in out nocopy number
55 ,p_time_category_name in varchar2
56 ,p_operator in varchar2
57 ,p_description in varchar2
58 ,p_display in varchar2
59 );
60 --
61 -- ----------------------------------------------------------------------------
62 -- |--------------------------------<update_time_category>----------------------|
63 -- ----------------------------------------------------------------------------
64 --
65 -- {Start Of Comments}
66 --
67 -- Description:
68 --
69 -- This API updates an existing Mapping with a given name, approval
70 -- rule usage covering a particular date range.
71 --
72 -- Prerequisites:
73 --
74 -- None
75 --
76 -- In Parameters:
77 -- Name Reqd Type Description
78 --
79 -- p_validate No boolean If TRUE then the database
80 -- remains unchanged. If FALSE
81 -- then the data_approval_rule
82 -- is updated. Default is FALSE.
83 -- p_time_category_id Yes number Primary Key for entity
84 -- p_object_version_number Yes number Object Version Number
85 -- p_time_category_name Yes varchar2 time category name
86 -- p_operator Yes varchar2 the operator to act upon the
87 -- TC components
88 --
89 -- Post Success:
90 --
91 -- when the mapping has been updated successfully the following
92 -- out parameters are set.
93 --
94 -- Name Type Description
95 --
96 -- p_object_version_number Number Object version number for the
97 -- updated rule
98 --
99 -- Post Failure:
100 --
101 -- The mapping will not be updated and an application error raised
102 --
103 -- Access Status:
104 -- Public.
105 --
106 -- {End Of Comments}
107 --
108 procedure update_time_category
109 (p_validate in boolean default false
110 ,p_time_category_id in number
111 ,p_object_version_number in out nocopy number
112 ,p_time_category_name in varchar2
113 ,p_operator in varchar2
114 ,p_description in varchar2
115 ,p_display in varchar2
116 );
117 --
118 -- ----------------------------------------------------------------------------
119 -- |-----------------------------< delete_time_category >-----------------------|
120 -- ----------------------------------------------------------------------------
121 --
122 -- {Start Of Comments}
123 --
124 -- Description:
125 --
126 -- This API deletes an existing Mapping
127 --
128 -- Prerequisites:
129 --
130 -- None
131 --
132 -- In Parameters:
133 -- Name Reqd Type Description
134 --
135 -- p_validate No boolean If TRUE then the database
136 -- remains unchanged. If FALSE
137 -- then the mapping
138 -- is deleted. Default is FALSE.
139 -- p_time_category_id Yes number Primary Key for entity
140 -- p_object_version_number Yes number Object Version Number
141 --
142 -- Post Success:
143 --
144 -- when the mapping has been deleted successfully the process
145 -- completes with success.
146 --
147 -- Post Failure:
148 --
149 -- The mapping will not be deleted and an application error raised
150 --
151 -- Access Status:
152 -- Public.
153 --
154 -- {End Of Comments}
155 --
156 procedure delete_time_category
157 (p_validate in boolean default false
158 ,p_time_category_id in number
159 ,p_time_Category_name in varchar2
160 ,p_object_version_number in number
161 );
162
163 -- ----------------------------------------------------------------------------
164 -- |---------------------------< set_dynamic_sql_string >---------------------|
165 -- ----------------------------------------------------------------------------
166 --
167 -- Description:
168 --
169 -- This API populates the dynamic sql sting TIME_SQL on the hxc_time_category
170 -- table. It must be called whenever a time category is created or its
171 -- components are updated.
172 --
173 -- Prerequisites:
174 --
175 -- None
176 --
177 -- In Parameters:
178 -- Name Reqd Type Description
179 --
180 -- p_time_category_id Yes number Primary Key for entity
181 --
182 -- Post Success:
183 --
184 -- when the TIME_SQL has been set successfully the process
185 -- completes with success.
186 --
187 -- Post Failure:
188 --
189 -- The TIME_SQL will not be created and an application error raised
190 --
191 -- Access Status:
192 -- Public.
193 --
194
195 procedure set_dynamic_sql_string ( p_time_category_id NUMBER );
196
197
198 PROCEDURE delete_old_comps;
199
200 FUNCTION get_component_type_name(p_component_type_id IN NUMBER)
201 RETURN VARCHAR2;
202
203
204 END hxc_time_category_api;
[Home] [Help]