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