1 PACKAGE EDR_EvidenceStore_PUB AS
2 /* $Header: EDRPEVRS.pls 120.0.12000000.1 2007/01/18 05:54:28 appldev ship $ */
3 /*#
4 * This is the public interface for the Evidence Store, and it retrieves the e-record details.
5 * @rep:scope public
6 * @rep:metalink 268669.1 Oracle E-Records API User's Guide
7 * @rep:product EDR
8 * @rep:displayname E-records Evidence Store APIs
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY EDR_EVIDENCE_STORE
11 */
12
13 /* -- Public Record Type Decleration */
14
15 TYPE Params_tbl_type IS TABLE of edr_psig.params_rec INDEX by Binary_INTEGER;
16
17 -- TYPE Signature_tbl_type IS TABLE of edr_psig_details%ROWTYPE INDEX by Binary_INTEGER;
18 TYPE Signature_tbl_type IS TABLE of edr_psig.Signature INDEX by Binary_INTEGER;
19
20
21
22
23 -- ----------------------------------------
24 -- API name : Open_Document
25 -- Type : Public
26 -- Function : create a document instance for signature
27 -- : and can associate signatures before closing the docuemnt
28 -- Versions : 1.0 17-Jul-03 created
29 -- ---------------------------------------
30
31 PROCEDURE open_Document (
32 p_api_version IN NUMBER,
33 p_init_msg_list IN VARCHAR2 default NULL,
34 p_commit IN VARCHAR2 default NULL,
35 x_return_status OUT NOCOPY VARCHAR2,
36 x_msg_count OUT NOCOPY NUMBER,
37 x_msg_data OUT NOCOPY VARCHAR2,
38 P_PSIG_XML IN CLOB DEFAULT NULL,
39 P_PSIG_DOCUMENT IN CLOB DEFAULT NULL,
40 P_PSIG_DOCUMENTFORMAT IN VARCHAR2 DEFAULT NULL,
41 P_PSIG_REQUESTER IN VARCHAR2,
42 P_PSIG_SOURCE IN VARCHAR2 DEFAULT NULL,
43 P_EVENT_NAME IN VARCHAR2 DEFAULT NULL,
44 P_EVENT_KEY IN VARCHAR2 DEFAULT NULL,
45 p_WF_Notif_ID IN NUMBER DEFAULT NULL,
46 x_DOCUMENT_ID OUT NOCOPY NUMBER );
47
48
49
50
51 -- ----------------------------------------
52 -- API name : Change_DocumentStatus
53 -- Type : Public
54 -- Function : Update a document
55 -- Versions : 1.0 17-Jul-03 created
56 -- ---------------------------------------
57
58 PROCEDURE Change_DocumentStatus (
59 p_api_version IN NUMBER,
60 p_init_msg_list IN VARCHAR2 default NULL,
61 p_commit IN VARCHAR2 default NULL,
62 x_return_status OUT NOCOPY VARCHAR2,
63 x_msg_count OUT NOCOPY NUMBER,
64 x_msg_data OUT NOCOPY VARCHAR2,
65 p_document_id IN NUMBER,
66 p_document_status IN VARCHAR2 );
67
68
69 -- ----------------------------------------
70 -- API name : Update_Document
71 -- Type : Public
72 -- Function : Update a document
73 -- Versions : 1.0 17-Jul-03 created
74 -- ---------------------------------------
75
76 PROCEDURE update_Document (
77 p_api_version IN NUMBER,
78 p_init_msg_list IN VARCHAR2 default NULL,
79 p_commit IN VARCHAR2 default NULL,
80 x_return_status OUT NOCOPY VARCHAR2,
81 x_msg_count OUT NOCOPY NUMBER,
82 x_msg_data OUT NOCOPY VARCHAR2,
83 P_DOCUMENT_ID IN NUMBER,
84 P_PSIG_XML IN CLOB DEFAULT NULL,
85 P_PSIG_DOCUMENT IN CLOB DEFAULT NULL,
86 P_PSIG_DOCUMENTFORMAT IN VARCHAR2 DEFAULT NULL,
87 P_PSIG_REQUESTER IN VARCHAR2,
88 P_PSIG_SOURCE IN VARCHAR2 DEFAULT NULL,
89 P_EVENT_NAME IN VARCHAR2 DEFAULT NULL,
90 P_EVENT_KEY IN VARCHAR2 DEFAULT NULL,
91 p_WF_Notif_ID IN NUMBER DEFAULT NULL );
92
93
94 -- ----------------------------------------
95 -- API name : Post_DocumentParameter
96 -- Type : Public
97 -- Function : Update a document
98 -- Versions : 1.0 17-Jul-03 created
99 -- ---------------------------------------
100
101 PROCEDURE Post_DocumentParameters (
102 p_api_version IN NUMBER,
103 p_init_msg_list IN VARCHAR2 default NULL,
104 p_commit IN VARCHAR2 default NULL,
105 x_return_status OUT NOCOPY VARCHAR2,
106 x_msg_count OUT NOCOPY NUMBER,
107 x_msg_data OUT NOCOPY VARCHAR2,
108 p_document_id IN NUMBER,
109 p_doc_parameters_tbl IN EDR_EvidenceStore_PUB.Params_tbl_type );
110
111
112
113
114
115 -- ----------------------------------------
116 -- API name : Close_Document
117 -- Type : Public
118 -- Function : close a document
119 -- Versions : 1.0 17-Jul-03 created
120 -- ---------------------------------------
121
122 PROCEDURE Close_Document (
123 p_api_version IN NUMBER,
124 p_init_msg_list IN VARCHAR2 default NULL,
125 p_commit IN VARCHAR2 default NULL,
126 x_return_status OUT NOCOPY VARCHAR2,
127 x_msg_count OUT NOCOPY NUMBER,
128 x_msg_data OUT NOCOPY VARCHAR2,
129 P_DOCUMENT_ID IN NUMBER );
130
131
132 -- ----------------------------------------
133 -- API name : Cancel_Document
134 -- Type : Public
135 -- Function : Update a document
136 -- Versions : 1.0 17-Jul-03 created
137 -- ---------------------------------------
138
139 PROCEDURE Cancel_Document (
140 p_api_version IN NUMBER,
141 p_init_msg_list IN VARCHAR2 default NULL,
142 p_commit IN VARCHAR2 default NULL,
143 x_return_status OUT NOCOPY VARCHAR2,
144 x_msg_count OUT NOCOPY NUMBER,
145 x_msg_data OUT NOCOPY VARCHAR2,
146 P_DOCUMENT_ID IN NUMBER );
147
148
149
150 /* this Procedure is used to requrest a signature for a given document .
151 this procedure will allow a new signature row to be create in the signature table for the
152 given document and user. This should have a follow up with postsignature api with more details */
153 -- ----------------------------------------
154 -- API name : Request_Signature
155 -- Type : Public
156 -- Function : Update a document
157 -- Versions : 1.0 17-Jul-03 created
158 -- ---------------------------------------
159
160 PROCEDURE Request_Signature (
161 p_api_version IN NUMBER,
162 p_init_msg_list IN VARCHAR2 default NULL,
163 p_commit IN VARCHAR2 default NULL,
164 x_return_status OUT NOCOPY VARCHAR2,
165 x_msg_count OUT NOCOPY NUMBER,
166 x_msg_data OUT NOCOPY VARCHAR2,
167 P_DOCUMENT_ID IN NUMBER,
168 P_USER_NAME IN VARCHAR2,
169 P_ORIGINAL_RECIPIENT IN VARCHAR2 DEFAULT NULL,
170 P_OVERRIDING_COMMENT IN VARCHAR2 DEFAULT NULL,
171 x_signature_id OUT NOCOPY NUMBER );
172
173
174 -- ----------------------------------------
175 -- API name : Post_Signature
176 -- Type : Public
177 -- Function : Update a document
178 -- Versions : 1.0 17-Jul-03 created
179 -- ---------------------------------------
180
181 PROCEDURE Post_Signature (
182 p_api_version IN NUMBER,
183 p_init_msg_list IN VARCHAR2 default NULL,
184 p_commit IN VARCHAR2 default NULL,
185 x_return_status OUT NOCOPY VARCHAR2,
186 x_msg_count OUT NOCOPY NUMBER,
187 x_msg_data OUT NOCOPY VARCHAR2,
188 P_DOCUMENT_ID IN NUMBER,
189 p_evidenceStore_id IN VARCHAR2,
190 P_USER_NAME IN VARCHAR2,
191 P_USER_RESPONSE IN VARCHAR2,
192 P_ORIGINAL_RECIPIENT IN VARCHAR2 DEFAULT NULL,
193 P_OVERRIDING_COMMENT IN VARCHAR2 DEFAULT NULL,
194 x_signature_id OUT NOCOPY NUMBER );
195
196
197
198 -- ----------------------------------------
199 -- API name : Post_SignatureParameter
200 -- Type : Public
201 -- Function : Update a document
202 -- Versions : 1.0 17-Jul-03 created
203 -- ---------------------------------------
204
205 PROCEDURE Post_SignatureParameters (
206 p_api_version IN NUMBER,
207 p_init_msg_list IN VARCHAR2 default NULL,
208 p_commit IN VARCHAR2 default NULL,
209 x_return_status OUT NOCOPY VARCHAR2,
210 x_msg_count OUT NOCOPY NUMBER,
211 x_msg_data OUT NOCOPY VARCHAR2,
212 p_signature_id IN NUMBER,
213 p_sig_parameters_tbl IN EDR_EvidenceStore_PUB.Params_tbl_type );
214
215
216 -- ----------------------------------------
217 -- API name : Get_DocumentDetails
218 -- Type : Public
219 -- Function : Update a document
220 -- Versions : 1.0 17-Jul-03 created
221 -- ---------------------------------------
222 /*#
223 * This API returns e-record details such as e-record XML, parameters associated with e-records and
224 * approver information based on e-record ID input.
225 * @rep:scope public
226 * @rep:lifecycle active
227 * @rep:displayname Retrieve e-record details
228 */
229 PROCEDURE Get_DocumentDetails (
230 p_api_version IN NUMBER,
231 p_init_msg_list IN VARCHAR2 default NULL,
232 x_return_status OUT NOCOPY VARCHAR2,
233 x_msg_count OUT NOCOPY NUMBER,
234 x_msg_data OUT NOCOPY VARCHAR2,
235 P_DOCUMENT_ID IN NUMBER,
236 x_document_rec OUT NOCOPY edr_psig_documents%ROWTYPE,
237 x_doc_parameters_tbl OUT NOCOPY EDR_EvidenceStore_PUB.Params_tbl_type,
238 x_signatures_tbl OUT NOCOPY EDR_EvidenceStore_PUB.Signature_tbl_type );
239
240
241 -- Bug 4135005 : Start
242
243 -- ----------------------------------------
244 -- API name : Get_SignatureDetails
245 -- Type : Public
246 -- Function : Returns Signature details
247 -- Versions : 1.0 28-Feb-05 created
248 -- ---------------------------------------
249 /*#
250 * This API returns Siganture details such as Siganture timestamp and Signature paramaters involving signature comments etc.
251 * @rep:scope public
252 * @rep:lifecycle active
253 * @rep:displayname Retrieve Signature details
254 */
255
256
257 PROCEDURE GET_SignatureDetails (
258 p_api_version IN NUMBER,
259 p_init_msg_list IN VARCHAR2 default NULL,
260 x_return_status OUT NOCOPY VARCHAR2,
261 x_msg_count OUT NOCOPY NUMBER,
262 x_msg_data OUT NOCOPY VARCHAR2,
263 P_SIGNATURE_ID IN NUMBER DEFAULT NULL,
264 X_SIGNATUREDETAILS OUT NOCOPY EDR_PSIG_DETAILS%ROWTYPE,
265 X_SIGNATUREPARAMS OUT NOCOPY EDR_EvidenceStore_PUB.params_tbl_type );
266
267
268 -- Bug 4135005 : End
269
270 -- ----------------------------------------
271 -- API name : Capture_Signature
272 -- Type : Public
273 -- Function : capture the signature for single event and generate document id + signature id
274 -- Versions : 1.0 17-Jul-03 created
275 -- ---------------------------------------
276
277 PROCEDURE Capture_Signature (
278 p_api_version IN NUMBER,
279 p_init_msg_list IN VARCHAR2 default NULL,
280 p_commit IN VARCHAR2 default NULL,
281 x_return_status OUT NOCOPY VARCHAR2,
282 x_msg_count OUT NOCOPY NUMBER,
283 x_msg_data OUT NOCOPY VARCHAR2,
284 p_psig_xml IN CLOB default null,
285 p_psig_document IN CLOB default null,
286 p_psig_docFormat IN VARCHAR2,
287 p_psig_requester IN VARCHAR2,
288 p_psig_source IN VARCHAR2,
289 p_event_name IN VARCHAR2,
290 p_event_key IN VARCHAR2,
291 p_wf_notif_id IN NUMBER,
292 x_document_id OUT NOCOPY NUMBER,
293 p_doc_parameters_tbl IN EDR_EvidenceStore_PUB.Params_tbl_type,
294 p_user_name IN VARCHAR2,
295 p_original_recipient IN VARCHAR2 default null,
296 p_overriding_comment IN VARCHAR2 default null,
297 x_signature_id OUT NOCOPY NUMBER,
298 p_evidenceStore_id IN NUMBER,
299 p_user_response IN VARCHAR2,
300 p_sig_parameters_tbl IN EDR_EvidenceStore_PUB.Params_tbl_type );
301
302
303 END EDR_EvidenceStore_PUB;
[Home] [Help]