1 Package hxc_retrieval_rule_comps_api AUTHID CURRENT_USER as
2 /* $Header: hxcrtcapi.pkh 120.0 2005/05/29 05:51:39 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_retrieval_rule_comps >------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
11 -- This API creates the Retrieval rule components
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 Retrieval rule
23 -- component is created.
24 -- Default is FALSE.
25 -- p_retrieval_rule_comp_id Yes number Primary Key for entity
26 -- p_retrieval_rule_id Yes number ID of the retrieval rule to
27 -- which the component belongs
28 -- p_status Yes varchar2 Status to determine the
29 -- retrieval by an application
30 -- p_time_recipient_id Yes number ID of the Application that
31 -- retrieves the data
32 -- p_object_version_number No number Object Version Number
33 -- p_effective_date No date Effective date
34 --
35 -- Post Success:
36 --
37 -- The OUT PARAMETERS set,after the retrieval rule component has been created
38 -- successfully,are:
39 --
40 -- Name Type Description
41 --
42 -- p_retrieval_rule_comp_id number Primary key of the new
43 -- retrieval rule comp
44 -- p_object_version_number number Object version number for the
45 -- new retrieval rule component
46 --
47 -- Post Failure:
48 --
49 -- The retrieval rule comp will not be created and an application error will be
50 -- raised.
51 --
52 -- Access Status:
53 -- Public.
54 --
55 -- {End Of Comments}
56 --
57 procedure create_retrieval_rule_comps
58 (p_validate in boolean default false
59 ,p_retrieval_rule_comp_id in out nocopy number
60 ,p_object_version_number in out nocopy number
61 ,p_retrieval_rule_id in number
62 ,p_status in varchar2
63 ,p_time_recipient_id in number
64 ,p_effective_date in date default null
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |------------------------<update_retrieval_rule_comps>----------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 --
73 -- Description:
74 --
75 -- This API updates an existing Retrieval Rule Component
76 --
77 -- Prerequisites:
78 --
79 -- None
80 --
81 -- In Parameters:
82 -- Name Reqd Type Description
83 --
84 -- p_validate No boolean If TRUE then the database
85 -- remains unchanged. If FALSE
86 -- then a retrieval rulei comp is
87 -- updated. Default is FALSE.
88 -- p_retrieval_rule_comp_id Yes number Primary Key for entity
89 -- p_retrieval_rule_id Yes number ID of the retrieval rule
90 -- to which the comp belongs
91 -- p_status Yes varchar2 Status to determine the
92 -- retrieval by an application
93 -- p_time_recipient_id Yes number ID of the Application that
94 -- retrieves the data
95 -- p_object_version_number No number Object Version Number
96 -- p_effective_date No date Effective date
97 --
98 -- Post Success:
99 --
100 -- when the retrieval rule comp has been updated successfully the following
101 -- out parameters are set.
102 --
103 -- Name Type Description
104 --
105 -- p_object_version_number Number Object version number for the
106 -- updated retrieval rule comp
107 --
108 -- Post Failure:
109 --
110 -- The retrieval rule comp will not be updated and an application error raised
111 --
112 -- Access Status:
113 -- Public.
114 --
115 -- {End Of Comments}
116 --
117 procedure update_retrieval_rule_comps
118 (p_validate in boolean default false
119 ,p_retrieval_rule_comp_id in number
120 ,p_object_version_number in out nocopy number
121 ,p_retrieval_rule_id in number
122 ,p_status in varchar2
123 ,p_time_recipient_id in number
124 ,p_effective_date in date default null
125 );
126 --
127 -- ----------------------------------------------------------------------------
128 -- |------------------------< delete_retrieval_rule_comps >--------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 --
133 -- Description:
134 --
135 -- This API deletes an existing retrieval rule component
136 --
137 -- Prerequisites:
138 --
139 -- None
140 --
141 -- In Parameters:
142 -- Name Reqd Type Description
143 --
144 -- p_validate No boolean If TRUE then the database
145 -- remains unchanged. If FALSE
146 -- then the retrieval rule comp
147 -- is deleted. Default is FALSE.
148 -- p_retrieval_rule_comp_id Yes number Primary Key for entity
149 -- p_object_version_number Yes number Object Version Number
150 --
151 -- Post Success:
152 --
153 -- when the retrieval rule comp has been deleted successfully the process
154 -- completes with success.
155 --
156 -- Post Failure:
157 --
158 -- The retrieval rule comp will not be deleted and an application error raised
159 --
160 -- Access Status:
161 -- Public.
162 --
163 -- {End Of Comments}
164 --
165 procedure delete_retrieval_rule_comps
166 (p_validate in boolean default false
167 ,p_retrieval_rule_comp_id in number
168 ,p_object_version_number in number
169 );
170 --
171 --
172 -- Added by ksethi ver 115.6
173 -- ----------------------------------------------------------------------------
174 -- |------------------------< chk_retr_as_unique >-----------------------------|
175 -- ----------------------------------------------------------------------------
176 Procedure chk_retr_as_unique
177 (
178 p_retrieval_rule_id in hxc_retrieval_rules.retrieval_rule_id%TYPE
179 );
180 --
181 --
182 END hxc_retrieval_rule_comps_api;
[Home] [Help]