1 Package hxc_resource_rules_api as
2 /* $Header: hxchrrapi.pkh 120.0 2005/05/29 05:38:47 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |-----------------------< create_resource_rules >--------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
11 -- This API creates the Resource Rules.
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 Resource Rule is
23 -- created.Default is FALSE.
24 -- p_resource_rule_id Yes number Primary Key for entity
25 -- p_name Yes varchar2 Name of the resource rule
26 -- p_eligibility_criteria_type Yes varchar2 Eligibilty criteria for the
27 -- resource rule
28 -- p_eligibility_criteria_id No varchar2 ID of the eligibility chosen.
29 -- eg. if eligibility_criteria_
30 -- type is PERSON then the elig
31 -- ibility_criteria_id will be
32 -- PERSON_ID.
33 -- p_pref_hierarchy_id Yes number ID of the preference hierarcy
34 -- involved in the resource rule
35 -- p_rule_evaluation_order Yes number The precedence of the resource-- rule
36 -- p_resource_type Yes varchar2 The resource type , the rule
37 -- applies to
38 -- p_start_date No date Start date for the resource
39 -- rule
40 -- p_end_date No date End date for the resource rule-- p_object_version_number No number Object Version Number
41 -- p_effective_date No date Effective Date
42 --
43 -- Post Success:
44 --
45 -- The OUT PARAMETERS set,after the resource rule has been created successfully,-- are:
46 --
47 -- Name Type Description
48 --
49 -- p_resource_rule_id number Primary key of the new resource
50 -- rule
51 -- p_object_version_number number Object Version Number of the new
52 -- resource rule
53 --
54 -- Post Failure:
55 --
56 -- The resource rule will not be created and an application error will be raised--
57 -- Access Status:
58 -- Public.
59 --
60 -- {End Of Comments}
61 --
62 procedure create_resource_rules
63 (p_validate in boolean default false
64 ,p_resource_rule_id in out nocopy number
65 ,p_object_version_number in out nocopy number
66 ,p_name in varchar2
67 ,p_business_group_id in number default null
68 ,p_legislation_code in varchar2 default null
69 ,p_eligibility_criteria_type in varchar2
70 ,p_eligibility_criteria_id in varchar2 default null
71 ,p_pref_hierarchy_id in number
72 ,p_rule_evaluation_order in number
73 ,p_resource_type in varchar2
74 ,p_start_date in date default null
75 ,p_end_date in date default null
76 ,p_effective_date in date default null
77 );
78 --
79 -- ----------------------------------------------------------------------------
80 -- |------------------------<update_resource_rules> --------------------------|
81 -- ----------------------------------------------------------------------------
82 --
83 -- {Start Of Comments}
84 --
85 -- Description:
86 --
87 -- This API updates an existing Resource Rule
88 --
89 -- Prerequisites:
90 --
91 -- None
92 --
93 -- In Parameters:
94 -- Name Reqd Type Description
95 --
96 -- p_validate No boolean IF TRUE then the database
97 -- remains unchanged.IF FALSE
98 -- then a new Resource Rule is
99 -- created.Default is FALSE.
100 -- p_resource_rule_id Yes number Primary Key for entity
101 -- p_name Yes varchar2 Name of the resource rule
102 -- p_eligibility_criteria_type Yes varchar2 Eligibilty criteria for the
103 -- resource rule
104 -- p_eligibility_criteria_id No varchar2 ID of the eligibility chosen.
105 -- eg. if eligibility_criteria_
106 -- type is PERSON then the elig
107 -- ibility_criteria_id will be
108 -- PERSON_ID.
109 -- p_pref_hierarchy_id Yes number ID of the preference hierarcy
110 -- involved in the resource rule
111 -- p_rule_evaluation_order Yes number The precedence of the resource
112 -- rule
113 -- p_resource_type Yes varchar2 The resource type , the rule
114 -- applies to
115 -- p_start_date No date Start date for the resource
116 -- rule
117 -- p_end_date No date End date for the resource rule
118 -- p_object_version_number No number Object Version Number
119 -- p_effective_date No date Effective Date
120 --
121 -- Post Success:
122 --
123 -- when the resource rule has been updated successfully the following
124 -- out parameters are set.
125 --
126 -- Name Type Description
127 --
128 -- p_object_version_number Number Object version number for the
129 -- updated resource rule
130 --
131 -- Post Failure:
132 --
133 -- The resource rule will not be updated and an application error raised
134 --
135 -- Access Status:
136 -- Public.
137 --
138 -- {End Of Comments}
139 --
140 procedure update_resource_rules
141 (p_validate in boolean default false
142 ,p_resource_rule_id in number
143 ,p_object_version_number in out nocopy number
144 ,p_name in varchar2
145 ,p_business_group_id in number default null
146 ,p_legislation_code in varchar2 default null
147 ,p_eligibility_criteria_type in varchar2
148 ,p_eligibility_criteria_id in varchar2 default null
149 ,p_pref_hierarchy_id in number
150 ,p_rule_evaluation_order in number
151 ,p_resource_type in varchar2
152 ,p_start_date in date default null
153 ,p_end_date in date default null
154 ,p_effective_date in date default null
155 );
156 --
157 -- ----------------------------------------------------------------------------
158 -- |------------------------< delete_resource_rules >--------------------------|
159 -- ----------------------------------------------------------------------------
160 --
161 -- {Start Of Comments}
162 --
163 -- Description:
164 --
165 -- This API deletes an existing Resource Rule
166 --
167 -- Prerequisites:
168 --
169 -- None
170 --
171 -- In Parameters:
172 -- Name Reqd Type Description
173 --
174 -- p_validate No boolean If TRUE then the database
175 -- remains unchanged. If FALSE
176 -- then the resource rule
177 -- is deleted. Default is FALSE.
178 -- p_resource_rule_id Yes number Primary Key for entity
179 -- p_object_version_number Yes number Object Version Number
180 --
181 -- Post Success:
182 --
183 -- when the resource rule has been deleted successfully the process
184 -- completes with success.
185 --
186 -- Post Failure:
187 --
188 -- The resource rule will not be deleted and an application error is raised
189 --
190 -- Access Status:
191 -- Public.
192 --
193 -- {End Of Comments}
194 --
195 procedure delete_resource_rules
196 (p_validate in boolean default false
197 ,p_resource_rule_id in number
198 ,p_object_version_number in number
199 );
200 --
201 end hxc_resource_rules_api;
[Home] [Help]