1 package EDR_TRANS_ACKN_PVT as
2 /* $Header: EDRVACKS.pls 120.0.12000000.1 2007/01/18 05:56:00 appldev ship $ */
3
4 /* Global Constants */
5 G_PKG_NAME CONSTANT varchar2(30) := 'EDR_TRANS_ACKN_PVT';
6 G_INSERT_MODE CONSTANT varchar2(30) := 'INSERT';
7 G_UPDATE_MODE CONSTANT varchar2(30) := 'UPDATE';
8
9 G_VALIDATE_DUP_ACK CONSTANT NUMBER := 10;
10 G_VALIDATE_ERECORD CONSTANT NUMBER := 20;
11 G_VALIDATE_STATUS CONSTANT NUMBER := 30;
12
13 -- Start of comments
14 -- API name : IS_STATUS_VALID
15 -- Type : Private Utility (Nat an API)
16 -- Function : Validate if the transaction ack status is valid in
17 -- a given scenario
18 -- Pre-reqs : None.
19 -- Parameters :
20 -- IN : p_status IN VARCHAR2(30) Required
21 -- : p_mode IN VARCHAR2(30) Required
22 -- Two possible values INSERT, UPDATE based on whether an
23 -- acknowledgement row is being inserted or updated
24 --
25 -- OUT : Function returns BOOLEAN TRUE or FALSE
26 --
27 -- Notes :
28 --
29 -- End of comments
30
31 function IS_STATUS_VALID
32 ( p_status IN VARCHAR2 ,
33 p_mode IN VARCHAR2
34 )
35 RETURN BOOLEAN;
36
37 -- Start of comments
38 -- API name : INSERT_ROW
39 -- Type : Private.
40 -- Function : Creates a row in the EDR_TRANS_ACKN table to
41 -- create an acknowledgement row for an eRecord.
42 -- Returns the primary key of the new row.
43 -- Pre-reqs : None.
44 -- Parameters :
45 -- IN : p_api_version IN NUMBER Required
46 -- p_init_msg_list IN VARCHAR2 Optional
47 -- Default = FND_API.G_FALSE
48 -- p_validation_level IN NUMBER Optional
49 -- Default = FND_API.G_VALID_LEVEL_FULL
50 -- Possible values
51 -- 1. FND_API.G_VALID_LEVEL_FULL: Full Validation
52 -- 2. FND_API.G_VALID_LEVEL_NONE: No Validation
53 -- 3. G_VALIDATE_DUP_ACK: Validated dup ack
54 -- 4. G_VALIDATE_ERECORD: 3 + validate erecord
55 -- 5. G_VALIDATE_STATUS: 3+4+ validate status
56 --
57 -- p_erecord_id IN NUMBER Required
58 -- The erecord id for which ackn is being recorded
59 -- p_trans_status IN VARCHAR2(30) Required
60 -- The status of the transaction for which ack is
61 -- being created. There is a limited set of possible
62 -- values: NOTACKNOWLEDGED, NOTCOLLECTED
63 -- p_ackn_by IN VARCHAR2(200) Optional
64 -- Default NULL
65 -- The source of the acknowledgement e.g a pgm name
66 -- p_ackn_note IN VARCHAR2(2000) Optional
67 -- Default NULL
68 -- Additional information/comments about the ackn
69 --
70 -- OUT : x_return_status OUT VARCHAR2
71 -- x_msg_count OUT NUMBER
72 -- x_msg_data OUT VARCHAR2
73 -- x_ackn_id OUT NUMBER
74 -- Primary key of the new row
75 --
76 -- Version : Current version 1.0
77 -- Initial version 1.0
78 --
79 -- Notes : This API doesnt commit or rollback because its
80 -- called from an autonomous context from the rule
81 -- function
82 --
83 -- End of comments
84
85 procedure INSERT_ROW
86 ( p_api_version IN NUMBER ,
87 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE ,
88 p_validation_level IN NUMBER default
89 FND_API.G_VALID_LEVEL_FULL ,
90 x_return_status OUT NOCOPY VARCHAR2 ,
91 x_msg_count OUT NOCOPY NUMBER ,
92 x_msg_data OUT NOCOPY VARCHAR2 ,
93 p_erecord_id IN NUMBER ,
94 p_trans_status IN VARCHAR2 ,
95 p_ackn_by IN VARCHAR2 default NULL ,
96 p_ackn_note IN VARCHAR2 default NULL ,
97 x_ackn_id OUT NOCOPY NUMBER
98 );
99
100 -- Start of comments
101 -- API name : SEND_ACKN_AUTO
102 -- Type : Private
103 -- Function : Creates an acknowledgement for an erecord in the
104 -- evidence store. This acknowledgement would say whether
105 -- the business transaction for which the erecord was
106 -- created, completed successfully or not. This API
107 -- does an autonomous commit.
108 -- Pre-reqs : The ERES event should have been raised and its erecord
109 -- id obtained before this api can be called
110 -- Parameters :
111 -- IN : p_api_version IN NUMBER Required
112 -- p_init_msg_list IN VARCHAR2 Optional
113 -- Default = FND_API.G_FALSE
114 -- p_event_name IN VARCHAR2(80) Required
115 -- The event name for which acknowledgement is sent
116 -- p_event_name IN VARCHAR2(240) Required
117 -- The event key for which acknowledgement is sent
118 -- p_erecord_id IN NUMBER Required
119 -- The erecord id for which ackn is being sent
120 -- p_trans_status IN VARCHAR2(30) Required
121 -- The status of the transaction for which ack is
122 -- being created. There is a limited set of possible
123 -- values: SUCCESS, ERROR.
124 -- p_ackn_by IN VARCHAR2(200) Optional
125 -- Default NULL
126 -- The source of the acknowledgement e.g a pgm name
127 -- p_ackn_note IN VARCHAR2(2000) Optional
128 -- Default NULL
129 -- Additional information/comments about the ackn
130 --
131 -- OUT : x_return_status OUT VARCHAR2
132 -- x_msg_count OUT NUMBER
133 -- x_msg_data OUT VARCHAR2
134 --
135 -- Version : Current version 1.0
136 -- Initial version 1.0
137 --
138 -- Notes : This API doesn an autonomous commit and is called
139 -- from a public API when a commit for the ack is required.
140 --
141 -- End of comments
142
143 procedure SEND_ACKN_AUTO
144 ( p_api_version IN NUMBER ,
145 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE ,
146 x_return_status OUT NOCOPY VARCHAR2 ,
147 x_msg_count OUT NOCOPY NUMBER ,
148 x_msg_data OUT NOCOPY VARCHAR2 ,
149 p_event_name IN VARCHAR2 ,
150 p_event_key IN VARCHAR2 ,
151 p_erecord_id IN NUMBER ,
152 p_trans_status IN VARCHAR2 ,
153 p_ackn_by IN VARCHAR2 default NULL ,
154 p_ackn_note IN VARCHAR2 default NULL
155 );
156
157 end EDR_TRANS_ACKN_PVT;
[Home] [Help]