1 Package hxc_retrieval_rule_grp_api AUTHID CURRENT_USER as
2 /* $Header: hxcrrgapi.pkh 120.0 2005/05/29 05:50:45 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_retrieval_rule_grp >---------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 --
9 -- Description:
10 --
11 -- This API creates a retreival rule group 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 data_approval_rule
23 -- is created. Default is FALSE.
24 -- p_retrieval_rule_grp_id No number Primary Key for retreival rule group
25 -- p_object_version_number No number Object Version Number
26 -- p_name Yes varchar2 Name for the retrieval_rule_grp
27 --
28 -- Post Success:
29 --
30 -- when the retrieval_rule_grp has been created successfully the following
31 -- out parameters are set.
32 --
33 -- Name Type Description
34 --
35 -- p_retrieval_rule_grp_id Number Primary Key for the new rule
36 -- p_object_version_number Number Object version number for the
37 -- new rule
38 --
39 -- Post Failure:
40 --
41 -- The retrieval_rule_grp will not be inserted and an application error raised
42 --
43 -- Access Status:
44 -- Public.
45 --
46 --
47 procedure create_retrieval_rule_grp
48 (p_validate in boolean default false
49 ,p_retrieval_rule_grp_id in out nocopy number
50 ,p_object_version_number in out nocopy number
51 ,p_name in varchar2
52 );
53 --
54 -- ----------------------------------------------------------------------------
55 -- |----------------------<update_retrieval_rule_grp>-------------------------|
56 -- ----------------------------------------------------------------------------
57 --
58 --
59 -- Description:
60 --
61 -- This API updates an existing Retrieval_Rule_Grp with a given name
62 --
63 -- Prerequisites:
64 --
65 -- None
66 --
67 -- In Parameters:
68 -- Name Reqd Type Description
69 --
70 -- p_validate No boolean If TRUE then the database
71 -- remains unchanged. If FALSE
72 -- then the data_approval_rule
73 -- is updated. Default is FALSE.
74 -- p_retrieval_rule_grp_id Yes number Primary Key for entity
75 -- p_object_version_number Yes number Object Version Number
76 -- p_name Yes varchar2 Name for the retrieval_rule_grp
77 --
78 -- Post Success:
79 --
80 -- when the retrieval_rule_grp has been updated successfully the following
81 -- out parameters are set.
82 --
83 -- Name Type Description
84 --
85 -- p_object_version_number Number Object version number for the
86 -- updated rule
87 --
88 -- Post Failure:
89 --
90 -- The retrieval_rule_grp will not be updated and an application error raised
91 --
92 -- Access Status:
93 -- Public.
94 --
95 --
96 procedure update_retrieval_rule_grp
97 (p_validate in boolean default false
98 ,p_retrieval_rule_grp_id in number
99 ,p_object_version_number in out nocopy number
100 ,p_name in varchar2
101 );
102 --
103 -- ----------------------------------------------------------------------------
104 -- |-------------------< delete_retrieval_rule_grp >--------------------------|
105 -- ----------------------------------------------------------------------------
106 --
107 --
108 -- Description:
109 --
110 -- This API deletes an existing Retrieval_Rule_Grp
111 --
112 -- Prerequisites:
113 --
114 -- None
115 --
116 -- In Parameters:
117 -- Name Reqd Type Description
118 --
119 -- p_validate No boolean If TRUE then the database
120 -- remains unchanged. If FALSE
121 -- then the retrieval_rule_grp
122 -- is deleted. Default is FALSE.
123 -- p_retrieval_rule_grp_id Yes number Primary Key for entity
124 -- p_object_version_number Yes number Object Version Number
125 --
126 -- Post Success:
127 --
128 -- when the retrieval_rule_grp has been deleted successfully the process
129 -- completes with success.
130 --
131 -- Post Failure:
132 --
133 -- The retrieval_rule_grp will not be deleted and an application error raised
134 --
135 -- Access Status:
136 -- Public.
137 --
138 --
139 procedure delete_retrieval_rule_grp
140 (p_validate in boolean default false
141 ,p_retrieval_rule_grp_id in number
142 ,p_object_version_number in number
143 );
144 --
145 -- ----------------------------------------------------------------------------
146 -- |-----------------------< chk_name >---------------------------------------|
147 -- ----------------------------------------------------------------------------
148 --
149 -- Description:
150 -- This procedure insures a valid retreival rule group name
151 --
152 -- Pre Conditions:
153 -- None
154 --
155 -- In Arguments:
156 -- name
157 -- entity_group_id
158 --
159 -- Post Success:
160 -- Processing continues if the name business rules have not been violated
161 --
162 -- Post Failure:
163 -- An application error is raised if the name is not valid
164 --
165 -- ----------------------------------------------------------------------------
166 Procedure chk_name
167 (
168 p_name in hxc_entity_groups.name%TYPE
169 ,p_entity_group_id in hxc_entity_groups.entity_group_id%TYPE
170 );
171 --
172 -- ----------------------------------------------------------------------------
173 -- |-----------------------< chk_delete >-------------------------------------|
174 -- ----------------------------------------------------------------------------
175 --
176 -- Description:
177 -- This procedure carries out delete time referential integrity checks
178 -- to ensure that a retreival rule group is not being referenced in a
179 -- in an approval hierarchy.
180 --
181 -- Pre Conditions:
182 -- None
183 --
184 -- In Arguments:
185 -- entity_group_id
186 --
187 -- Post Success:
188 -- Processing continues if the name is not being referenced
189 --
190 -- Post Failure:
191 -- An application error is raised if the rule is being used.
192 --
193 -- ----------------------------------------------------------------------------
194 Procedure chk_delete
195 (
196 p_entity_group_id in hxc_entity_groups.entity_group_id%TYPE
197 );
198 --
199 --
200 END hxc_retrieval_rule_grp_api;
[Home] [Help]