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