1 package EDR_EVENT_RELATIONSHIP_PUB as
2 /* $Header: EDRPRELS.pls 120.0.12000000.1 2007/01/18 05:54:41 appldev ship $ */
3 /*#
4 * These APIs establish relationship between e-records.
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 /* Global Types */
14
15 -- Record type for a relationship record to establish parent child relationship
16 -- between two erecords
17
18 Type INTER_EVENT_REC_TYPE IS RECORD
19 ( parent_event_name VARCHAR2(80) ,
20 parent_event_key VARCHAR2(240) ,
21 parent_erecord_id NUMBER ,
22 child_event_name VARCHAR2(80) ,
23 child_event_key VARCHAR2(240) ,
24 child_erecord_id NUMBER
25 );
26
27 -- Table of relationship records
28
29 TYPE INTER_EVENT_TBL_TYPE IS TABLE OF INTER_EVENT_REC_TYPE INDEX BY BINARY_INTEGER;
30
31 /* Global Constants */
32 G_PKG_NAME CONSTANT varchar2(30) := 'EDR_EVENT_RELATIONSHIP_PUB';
33
34 -- Start of comments
35 -- API name : CREATE_RELATIONSHIP
36 -- Type : Public.
37 -- Function : Creates a row in the EDR_EVENT_RELATIONSHIP table to
38 -- establish a parent-event relationship between two event
39 -- erecords.
40 -- Pre-reqs : None.
41 -- Parameters :
42 -- IN : p_api_version IN NUMBER Required
43 -- p_init_msg_list IN VARCHAR2 Optional
44 -- Default = FND_API.G_FALSE
45 -- p_commit IN VARCHAR2 Optional
46 -- Default = FND_API.G_FALSE
47 -- p_validation_level IN NUMBER Optional
48 -- Default = FND_API.G_VALID_LEVEL_FULL
49 -- p_parent_erecord_id IN NUMBER Required
50 -- p_parent_event_name IN VARCHAR2(80) Optional
51 -- Default NULL
52 -- p_parent_event_key IN VARCHAR2(240) Optional
53 -- Default NULL
54 -- p_child_erecord_id IN NUMBER Required
55 -- p_child_event_name IN VARCHAR2(80) Optional
56 -- Default NULL
57 -- p_child_event_key IN VARCHAR2(240) Optional
58 -- Default NULL
59 --
60 -- OUT : x_return_status OUT VARCHAR2
61 -- x_msg_count OUT NUMBER
62 -- x_msg_data OUT VARCHAR2
63 -- x_relationship_id OUT NUMBER
64 -- PK of the new row or null if there is an error
65 --
66 -- Version : Current version 1.0
67 -- Initial version 1.0
68 --
69 -- Notes : The event names and event keys are optional but if provided,
70 -- would be validated to be matching those in the evidence store
71 -- for the given erecord id. This API would insert a row in the
72 -- relationship table and return the primary key of the new row
73 -- in parameter x_relationship_id
74 --
75 -- End of comments
76 /*#
77 * This API establishes a related event relationship between two events in evidence store.
78 * @rep:scope public
79 * @rep:lifecycle active
80 * @rep:displayname Establish relationships between e-records
81 */
82
83 procedure CREATE_RELATIONSHIP
84 ( p_api_version IN NUMBER ,
85 p_init_msg_list IN VARCHAR2 default NULL ,
86 p_commit IN VARCHAR2 default NULL ,
87 p_validation_level IN NUMBER default NULL ,
88 x_return_status OUT NOCOPY VARCHAR2 ,
89 x_msg_count OUT NOCOPY NUMBER ,
90 x_msg_data OUT NOCOPY VARCHAR2 ,
91 P_PARENT_ERECORD_ID IN NUMBER ,
92 P_PARENT_EVENT_NAME IN VARCHAR2 default NULL ,
93 P_PARENT_EVENT_KEY IN VARCHAR2 default NULL ,
94 P_CHILD_ERECORD_ID IN NUMBER ,
95 P_CHILD_EVENT_NAME IN VARCHAR2 default NULL ,
96 P_CHILD_EVENT_KEY IN VARCHAR2 default NULL ,
97 X_RELATIONSHIP_ID OUT NOCOPY NUMBER
98 );
99
100 -- Start of comments
101 -- API name : VALIDATE_RELATIONSHIP
102 -- Type : Public.
103 -- Function : Validates that the given parameters would create a
104 -- row in edr_event_relationship table
105 -- Pre-reqs : None.
106 -- Parameters :
107 -- IN : p_api_version IN NUMBER Required
108 -- p_init_msg_list IN VARCHAR2 Optional
109 -- Default = FND_API.G_FALSE
110 -- p_parent_erecord_id IN NUMBER Required
111 -- p_parent_event_name IN VARCHAR2(80) Optional
112 -- Default NULL
113 -- p_parent_event_key IN VARCHAR2(240) Optional
114 -- Default NULL
115 -- p_child_erecord_id IN NUMBER Required
116 -- p_child_event_name IN VARCHAR2(80) Optional
117 -- Default NULL
118 -- p_child_event_key IN VARCHAR2(240) Optional
119 -- Default NULL
120 --
121 -- OUT : x_return_status OUT VARCHAR2
122 -- 'E' means that the validation has failed. 'S' means
123 -- its successful
124 -- x_msg_count OUT NUMBER
125 -- x_msg_data OUT VARCHAR2
126 --
127 -- Version : Current version 1.0
128 -- Initial version 1.0
129 --
130 -- Notes : First checks to see if the erecord ids are valid or not
131 -- If the erecord ids are valid then it validates that
132 -- the event name and event key are valid for the given
133 -- erecord id
134 -- The outcome of validation is provided in x_return_status
135 --
136 -- End of comments
137
138 PROCEDURE VALIDATE_RELATIONSHIP
139 ( p_api_version IN NUMBER ,
140 p_init_msg_list IN VARCHAR2 default NULL ,
141 x_return_status OUT NOCOPY VARCHAR2 ,
142 x_msg_count OUT NOCOPY NUMBER ,
143 x_msg_data OUT NOCOPY VARCHAR2 ,
144 P_PARENT_ERECORD_ID IN NUMBER ,
145 P_PARENT_EVENT_NAME IN VARCHAR2 default NULL ,
146 P_PARENT_EVENT_KEY IN VARCHAR2 default NULL ,
147 P_CHILD_ERECORD_ID IN NUMBER ,
148 P_CHILD_EVENT_NAME IN VARCHAR2 default NULL ,
149 P_CHILD_EVENT_KEY IN VARCHAR2 default NULL
150 );
151
152 end EDR_EVENT_RELATIONSHIP_PUB;
[Home] [Help]