1 PACKAGE XNP_ADAPTER AUTHID CURRENT_USER AS
2 /* $Header: XNPADAPS.pls 120.2 2006/02/13 07:37:01 dputhiye ship $ */
3
4 TYPE Fe_Data_Rec IS RECORD
5 (
6 attribute_name VARCHAR2(1024),
7 attribute_value VARCHAR2(1024)
8 ) ;
9
10 TYPE Fe_Data IS TABLE OF Fe_Data_Rec INDEX BY BINARY_INTEGER ;
11
12 --Sends an OPEN command to the specified Adapter
13 --using -the channel name as the Pipe
14 --
15 PROCEDURE open( p_fe_name IN VARCHAR2
16 ,p_channel_name IN VARCHAR2
17 ,x_error_code OUT NOCOPY NUMBER
18 ,x_error_message OUT NOCOPY VARCHAR2 );
19
20 --Sends a CLOSE command to the specified Adapter
21 --using the channel name as the Pipe
22 --
23 PROCEDURE close( p_fe_name IN VARCHAR2
24 ,p_channel_name IN VARCHAR2
25 ,x_error_code OUT NOCOPY NUMBER
26 ,x_error_message OUT NOCOPY VARCHAR2 );
27
28 --Sends a SUSPEND command to the specified Adapter
29 --using the channel name as the Pipe
30 --
31 PROCEDURE suspend( p_fe_name IN VARCHAR2
32 ,p_channel_name IN VARCHAR2
33 ,x_error_code OUT NOCOPY NUMBER
34 ,x_error_message OUT NOCOPY VARCHAR2 );
35
36 --Sends a RESUME command to the specified Adapter
37 --using the channel name as the Pipe
38 --
39 PROCEDURE resume( p_fe_name IN VARCHAR2
40 ,p_channel_name IN VARCHAR2
41 ,x_error_code OUT NOCOPY NUMBER
42 ,x_error_message OUT NOCOPY VARCHAR2 );
43
44 --Sends a SHUTDOWN command to the specified Adapter
45 --using the channel name as the Pipe
46 --
47 PROCEDURE shutdown( p_fe_name IN VARCHAR2
48 ,p_channel_name IN VARCHAR2
49 ,x_error_code OUT NOCOPY NUMBER
50 ,x_error_message OUT NOCOPY VARCHAR2 );
51
52 --Closes a FILE on a specific channel.
53 --Using * for file name closes all files.
54 --Not specifying anything closes the default file.
55 --
56 PROCEDURE close_file( p_fe_name IN VARCHAR2
57 ,p_channel_name IN VARCHAR2
58 ,p_file_name IN VARCHAR2 DEFAULT NULL
59 ,x_error_code OUT NOCOPY NUMBER
60 ,x_error_message OUT NOCOPY VARCHAR2 );
61
62 -- New FTP API recommended
63 -- FTPs a FILE on a specific channel.
64 -- Using * for file name FTPs all files.
65 -- Not specifying anything FTPs the default file.
66
67 PROCEDURE ftp( p_channel_name IN VARCHAR2
68 ,p_file_name IN VARCHAR2 DEFAULT NULL
69 ,x_error_code OUT NOCOPY NUMBER
70 ,x_error_message OUT NOCOPY VARCHAR2);
71
72 -- maintained for backward compatibility
73 -- FTPs a FILE on a specific channel.
74 -- Using * for file name FTPs all files.
75 -- Not specifying anything FTPs the default file.
76 --
77 PROCEDURE ftp( p_fe_name IN VARCHAR2
78 ,p_channel_name IN VARCHAR2
79 ,p_file_name IN VARCHAR2 DEFAULT NULL
80 ,x_error_code OUT NOCOPY NUMBER
81 ,x_error_message OUT NOCOPY VARCHAR2 );
82
83 --API to send an XML message to the adapter
84 --
85 PROCEDURE user_control( p_fe_name IN VARCHAR2
86 ,p_channel_name IN VARCHAR2
87 ,p_operation IN VARCHAR2
88 ,p_operation_data IN fe_data
89 ,x_error_code OUT NOCOPY NUMBER
90 ,x_error_message OUT NOCOPY VARCHAR2 );
91
92 --Notifies the FMC of adapter errors
93 --
94 PROCEDURE notify_fmc
95 (p_msg_header IN xnp_message.msg_header_rec_type
96 ,p_msg_text IN VARCHAR2
97 ,x_error_code OUT NOCOPY NUMBER
98 ,x_error_message OUT NOCOPY VARCHAR2
99 );
100
101 END xnp_adapter ;
[Home] [Help]