1 Package hxc_tk_group_query_api AUTHID CURRENT_USER as
2 /* $Header: hxctkgqapi.pkh 120.0 2005/05/29 06:11:05 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_tk_group_query >---------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 --
9 -- Description:
10 --
11 -- This API creates a timekeeper group query with a given name
12 --
13 -- Prerequisites:
14 --
15 -- None
16 --
17 -- In Parameters:
18 -- Name Reqd Type Description
19 --
20 -- p_validate No boolean If TRUE then the database
21 -- remains unchanged. If FALSE
22 -- then a new tk group query
23 -- is created. Default is FALSE.
24 -- p_tk_group_query_id No number Primary Key for timekeeper group query group query
25 -- p_tk_group_id Yes number Foreign Key for timekeeper group query group
26 -- p_object_version_number No number Object Version Number
27 -- p_group_query_name Yes varchar2 tk group Name for the tk_group_query
28 -- p_include_exclude Yes varchar2 Include or Exclude flag
29 -- p_system_user Yes varchar2 System or User flag
30 --
31 -- Post Success:
32 --
33 -- when the tk_group_query has been created successfully the following
34 -- out parameters are set.
35 --
36 -- Name Type Description
37 --
38 -- p_tk_group_query_id Number Primary Key for the new tk group query
39 -- p_object_version_number Number Object version number for the
40 -- new tk group
41 --
42 -- Post Failure:
43 --
44 -- The timekeeper group query will not be inserted and an application error raised
45 --
46 -- Access Status:
47 -- Public.
48 --
49 --
50 procedure create_tk_group_query
51 (p_validate in boolean default false
52 ,p_tk_group_query_id in out nocopy number
53 ,p_tk_group_id in number
54 ,p_object_version_number in out nocopy number
55 ,p_group_query_name in varchar2
56 ,p_include_exclude in varchar2
57 ,p_system_user in varchar2
58 );
59 --
60 -- ----------------------------------------------------------------------------
61 -- |-------------------------<update_tk_group_query>------------------------|
62 -- ----------------------------------------------------------------------------
63 --
64 --
65 -- Description:
66 --
67 -- This API updates an existing Tk_Group_Query with a given name
68 --
69 -- Prerequisites:
70 --
71 -- None
72 --
73 -- In Parameters:
74 -- Name Reqd Type Description
75 --
76 -- p_validate No boolean If TRUE then the database
77 -- remains unchanged. If FALSE
78 -- then the tk group query
79 -- is updated. Default is FALSE.
80 -- p_tk_group_id Yes number Primary Key for entity
81 -- p_tk_group_query_id Yes number Foreign Key for entity
82 -- p_object_version_number Yes number Object Version Number
83 -- p_group_query_name Yes varchar2 tk group Name for the timekeeper group query
84 -- p_include_exclude Yes varchar2 Include or Exclude flag
85 -- p_system_user Yes varchar2 System or User flag
86 --
87 -- Post Success:
88 --
89 -- when the timekeeper group query has been updated successfully the following
90 -- out parameters are set.
91 --
92 -- Name Type Description
93 --
94 -- p_object_version_number Number Object version number for the
95 -- updated tk group query
96 --
97 -- Post Failure:
98 --
99 -- The tk_group_query will not be updated and an application error raised
100 --
101 -- Access Status:
102 -- Public.
103 --
104 --
105 procedure update_tk_group_query
106 (p_validate in boolean default false
107 ,p_tk_group_id in number
108 ,p_tk_group_query_id in number
109 ,p_object_version_number in out nocopy number
110 ,p_group_query_name in varchar2
111 ,p_include_exclude in varchar2
112 ,p_system_user in varchar2
113 );
114 --
115 -- ----------------------------------------------------------------------------
116 -- |----------------------< delete_tk_group_query >-------------------------|
117 -- ----------------------------------------------------------------------------
118 --
119 --
120 -- Description:
121 --
122 -- This API deletes an existing Tk_Group_Query
123 --
124 -- Prerequisites:
125 --
126 -- None
127 --
128 -- In Parameters:
129 -- Name Reqd Type Description
130 --
131 -- p_validate No boolean If TRUE then the database
132 -- remains unchanged. If FALSE
133 -- then the tk_group_query
134 -- is deleted. Default is FALSE.
135 -- p_tk_group_query_id Yes number Primary Key for entity
136 -- p_object_version_number Yes number Object Version Number
137 --
138 -- Post Success:
139 --
140 -- when the timekeeper group query has been deleted successfully the process
141 -- completes with success.
142 --
143 -- Post Failure:
144 --
145 -- The tk_group_query will not be deleted and an application error raised
146 --
147 -- Access Status:
148 -- Public.
149 --
150 --
151 procedure delete_tk_group_query
152 (p_validate in boolean default false
153 ,p_tk_group_query_id in number
154 ,p_object_version_number in number
155 );
156 --
157 -- ----------------------------------------------------------------------------
158 -- |-----------------------< chk_name >---------------------------------------|
159 -- ----------------------------------------------------------------------------
160 --
161 -- Description:
162 -- This procedure insures a valid timekeeper group query name
163 --
164 -- Pre Conditions:
165 -- None
166 --
167 -- In Arguments:
168 -- group_query_name
169 -- tk_group_query_id
170 --
171 -- Post Success:
172 -- Processing continues if the name business tk group querys have not been violated
173 --
174 -- Post Failure:
175 -- An application error is raised if the name is not valid
176 --
177 -- ----------------------------------------------------------------------------
178 Procedure chk_name
179 (
180 p_group_query_name in varchar2
181 ,p_tk_group_id in number
182 ,p_tk_group_query_id in number
183 );
184 --
185 -- ----------------------------------------------------------------------------
186 -- |-----------------------< chk_tk_group_id >--------------------------------|
187 -- ----------------------------------------------------------------------------
188 --
189 -- Description:
190 -- This procedure insures a valid timekeeper group id
191 --
192 -- Pre Conditions:
193 -- None
194 --
195 -- In Arguments:
196 -- tk_group_id
197 --
198 -- Post Success:
199 -- Processing continues if the name business tk group querys have not been violated
200 --
201 -- Post Failure:
202 -- An application error is raised if the name is not valid
203 --
204 -- ----------------------------------------------------------------------------
205 Procedure chk_tk_group_id
206 (
207 p_tk_group_id in number
208 );
209 --
210 -- ----------------------------------------------------------------------------
211 -- |-----------------------< chk_delete >-------------------------------------|
212 -- ----------------------------------------------------------------------------
213 --
214 -- Description:
215 -- This procedure carries out delete time referential integrity checks
216 -- Currently there are none but include this now for minimum impact
217 -- in the future.
218 --
219 -- Pre Conditions:
220 -- None
221 --
222 -- In Arguments:
223 -- tk_group_id
224 --
225 -- Post Success:
226 -- Processing continues if the name is not being referenced
227 --
228 -- Post Failure:
229 -- An application error is raised if the tk group query is being used.
230 --
231 -- ----------------------------------------------------------------------------
232 Procedure chk_delete
233 (
234 p_tk_group_query_id in number
235 );
236 --
237 -- ----------------------------------------------------------------------------
238 -- |-----------------------< maintain_tk_group_query >------------------------|
239 -- ----------------------------------------------------------------------------
240 --
241 -- Description:
242 -- This procedures maintains the hxc tk group query entity.
243 -- It is called whenever a tk group query criteria row is created.
244 --
245 -- Pre Conditions:
246 -- None
247 --
248 -- In Arguments:
249 -- p_tk_group_query_id
250 -- p_tk_group_id
251 --
252 -- Post Success:
253 -- Processing continues if the grpu query is created or retrieved successfully.
254 --
255 -- Post Failure:
256 -- An application error is raised if the tk group query is being used.
257 --
258 -- ----------------------------------------------------------------------------
259 Procedure maintain_tk_group_query
260 (
261 p_tk_group_query_id in out nocopy number
262 ,p_tk_group_id in number
263 );
264
265 --
266 END hxc_tk_group_query_api;
[Home] [Help]