1 Package hxc_ret_rule_grp_comp_api AUTHID CURRENT_USER as
2 /* $Header: hxcrrcapi.pkh 120.0 2005/05/29 05:50:12 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------< create_ret_rule_grp_comp >-------------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 --
9 -- Description:
10 --
11 -- This API creates a Retrieval Rule Group Comp for a given entity
12 -- and entity group.
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 entity_group_comp
24 -- is created. Default is FALSE.
25 -- p_ret_rule_grp_comp_id No number Primary Key for entity
26 -- p_object_version_number No number Object Version Number
27 -- p_retrieval_rule_id Yes number Retrieval Rule Id
28 -- p_retrieval_rule_grp_id Yes number Retrieval Rule Group Id
29 --
30 -- Post Success:
31 --
32 -- when the entity_group_comp has been created successfully the following
33 -- out parameters are set.
34 --
35 -- Name Type Description
36 --
37 -- p_ret_rule_grp_comp_id Number Primary Key for the retrieval rule grp
38 -- p_object_version_number Number Object version number for the
39 -- new retrieval rule group comp
40 --
41 -- Post Failure:
42 --
43 -- The Retrieval Rule Group Comp will not be inserted and an application error raised
44 --
45 -- Access Status:
46 -- Public.
47 --
48 --
49 procedure create_ret_rule_grp_comp
50 (p_validate in boolean default false
51 ,p_effective_date in date
52 ,p_ret_rule_grp_comp_id in out nocopy number
53 ,p_object_version_number in out nocopy number
54 ,p_retrieval_rule_id in number
55 ,p_retrieval_rule_grp_id in number
56 ,p_attribute_category in varchar2 default null
57 ,p_attribute1 in varchar2 default null
58 ,p_attribute2 in varchar2 default null
59 ,p_attribute3 in varchar2 default null
60 ,p_attribute4 in varchar2 default null
61 ,p_attribute5 in varchar2 default null
62 ,p_attribute6 in varchar2 default null
63 ,p_attribute7 in varchar2 default null
64 ,p_attribute8 in varchar2 default null
65 ,p_attribute9 in varchar2 default null
66 ,p_attribute10 in varchar2 default null
67 ,p_attribute11 in varchar2 default null
68 ,p_attribute12 in varchar2 default null
69 ,p_attribute13 in varchar2 default null
70 ,p_attribute14 in varchar2 default null
71 ,p_attribute15 in varchar2 default null
72 ,p_attribute16 in varchar2 default null
73 ,p_attribute17 in varchar2 default null
74 ,p_attribute18 in varchar2 default null
75 ,p_attribute19 in varchar2 default null
76 ,p_attribute20 in varchar2 default null
77 ,p_attribute21 in varchar2 default null
78 ,p_attribute22 in varchar2 default null
79 ,p_attribute23 in varchar2 default null
80 ,p_attribute24 in varchar2 default null
81 ,p_attribute25 in varchar2 default null
82 ,p_attribute26 in varchar2 default null
83 ,p_attribute27 in varchar2 default null
84 ,p_attribute28 in varchar2 default null
85 ,p_attribute29 in varchar2 default null
86 ,p_attribute30 in varchar2 default null
87 ,p_called_from_form in varchar2 default 'Y' -- NOTE: default to Y because no DF for Retrieval Rule Grps
88 );
89 --
90 -- ----------------------------------------------------------------------------
91 -- |--------------------<update_ret_rule_grp_comp >---------------------|
92 -- ----------------------------------------------------------------------------
93 --
94 --
95 -- Description:
96 --
97 -- This API updates an existing Retrieval Rule Group Comp with a given name and DDF
98 -- context
99 --
100 -- Prerequisites:
101 --
102 -- None
103 --
104 -- In Parameters:
105 -- Name Reqd Type Description
106 --
107 -- p_validate No boolean If TRUE then the database
108 -- remains unchanged. If FALSE
109 -- then the entity_group_comp
110 -- is updated. Default is FALSE.
111 -- p_ret_rule_grp_comp_id Yes number Primary Key for retrieval rule grp
112 -- p_object_version_number Yes number Object Version Number
113 -- p_retrieval_rule_id No number Retrieval Rule ID
114 -- p_retrieval_rule_grp_id No number Retrieval Rule Group ID
115 --
116 -- Post Success:
117 --
118 -- when the ret_rule_grp_comp has been updated successfully the following
119 -- out parameters are set.
120 --
121 -- Name Type Description
122 --
123 -- p_object_version_number Number Object version number for the
124 -- updated retrieval rule group comp
125 --
126 -- Post Failure:
127 --
128 -- The Retrieval Rule Group Comp will not be updated and an application error raised
129 --
130 -- Access Status:
131 -- Public.
132 --
133 --
134 procedure update_ret_rule_grp_comp
135 (p_validate in boolean default false
136 ,p_effective_date in date
137 ,p_ret_rule_grp_comp_id in number
138 ,p_object_version_number in out nocopy number
139 ,p_retrieval_rule_id in number default null
140 ,p_retrieval_rule_grp_id in number default null
141 ,p_attribute_category in varchar2 default null
142 ,p_attribute1 in varchar2 default null
143 ,p_attribute2 in varchar2 default null
144 ,p_attribute3 in varchar2 default null
145 ,p_attribute4 in varchar2 default null
146 ,p_attribute5 in varchar2 default null
147 ,p_attribute6 in varchar2 default null
148 ,p_attribute7 in varchar2 default null
149 ,p_attribute8 in varchar2 default null
150 ,p_attribute9 in varchar2 default null
151 ,p_attribute10 in varchar2 default null
152 ,p_attribute11 in varchar2 default null
153 ,p_attribute12 in varchar2 default null
154 ,p_attribute13 in varchar2 default null
155 ,p_attribute14 in varchar2 default null
156 ,p_attribute15 in varchar2 default null
157 ,p_attribute16 in varchar2 default null
158 ,p_attribute17 in varchar2 default null
159 ,p_attribute18 in varchar2 default null
160 ,p_attribute19 in varchar2 default null
161 ,p_attribute20 in varchar2 default null
162 ,p_attribute21 in varchar2 default null
163 ,p_attribute22 in varchar2 default null
164 ,p_attribute23 in varchar2 default null
165 ,p_attribute24 in varchar2 default null
166 ,p_attribute25 in varchar2 default null
167 ,p_attribute26 in varchar2 default null
168 ,p_attribute27 in varchar2 default null
169 ,p_attribute28 in varchar2 default null
170 ,p_attribute29 in varchar2 default null
171 ,p_attribute30 in varchar2 default null
172 ,p_called_from_form in varchar2 default 'Y' -- NOTE: default to Y because no DF for Retrieval Rule Grps
173 );
174 --
175 -- ----------------------------------------------------------------------------
176 -- |---------------------< delete_ret_rule_grp_comp >---------------------|
177 -- ----------------------------------------------------------------------------
178 --
179 --
180 -- Description:
181 --
182 -- This API deletes an existing Retrieval Rule Group Comp
183 --
184 -- Prerequisites:
185 --
186 -- None
187 --
188 -- In Parameters:
189 -- Name Reqd Type Description
190 --
191 -- p_validate No boolean If TRUE then the database
192 -- remains unchanged. If FALSE
193 -- then the entity_group_comp
194 -- is deleted. Default is FALSE.
195 -- p_ret_rule_grp_comp_id Yes number Primary Key for retrieval rule grp
196 -- p_object_version_number Yes number Object Version Number
197 --
198 -- Post Success:
199 --
200 -- when the entity_group_comp has been deleted successfully the process
201 -- completes with success.
202 --
203 -- Post Failure:
204 --
205 -- The Retrieval Rule Group Comp will not be deleted and an application error raised
206 --
207 -- Access Status:
208 -- Public.
209 --
210 --
211 procedure delete_ret_rule_grp_comp
212 (p_validate in boolean default false
213 ,p_ret_rule_grp_comp_id in number
214 ,p_retrieval_rule_grp_id in number
215 ,p_object_version_number in number
216 );
217 --
218 Procedure chk_rr_unique
219 (
220 p_ret_rule_grp_comp_id in hxc_entity_group_comps.entity_group_comp_id%TYPE
221 , p_retrieval_rule_grp_id in hxc_entity_group_comps.entity_group_id%TYPE
222 , p_retrieval_rule_id in hxc_entity_group_comps.entity_id%TYPE );
223 --
224 END hxc_ret_rule_grp_comp_api;