1 PACKAGE jtf_esc_wf_events_pvt AUTHID CURRENT_USER AS
2 /* $Header: jtfecbes.pls 120.1 2005/07/02 00:41:03 appldev noship $ */
3 /*#
4 * This is the private interface to the JTF Escalation Management.
5 * This Interface is used for raising a BES event in Escalation
6 * Management, for Create / Update / Delete of Escaltion and its
7 * references.
8 *
9 * @rep:scope private
10 * @rep:product JTF
11 * @rep:lifecycle active
12 * @rep:displayname Escalation Management
13 * @rep:compatibility S
14 * @rep:category BUSINESS_ENTITY JTA_ESCALATION
15 */
16
17 /*#
18 * Raises the Create Escalation Event
19 *
20 * @param p_esc_rec the escalation attributes used when raising a create event
21 * @rep:scope private
22 * @rep:lifecycle active
23 * @rep:displayname Raise Create Escalation Event
24 * @rep:compatibility S
25 */
26 PROCEDURE publish_create_esc (
27 P_ESC_REC IN jtf_ec_pvt.Esc_Rec_type
28 );
29
30 /*#
31 * Raises the Update Escalation Event
32 *
33 * @param p_esc_rec the escalation attributes used when raising a update event
34 * @rep:scope private
35 * @rep:lifecycle active
36 * @rep:displayname Raise Update Escalation Event
37 * @rep:compatibility S
38 */
39 PROCEDURE publish_update_esc (
40 P_ESC_REC IN jtf_ec_pvt.Esc_Rec_type
41 );
42
43 /*#
44 * Raises the Delete Escalation Event
45 *
46 * @param p_esc_rec the escalation attributes used when raising a delete event
47 * @rep:scope private
48 * @rep:lifecycle active
49 * @rep:displayname Raise Delete Escalation Event
50 * @rep:compatibility S
51 */
52 PROCEDURE publish_delete_esc (
53 P_ESC_REC IN jtf_ec_pvt.Esc_Rec_type
54 );
55
56
57 /*#
58 * Raises the Create Escalation References Event
59 *
60 * @param p_esc_ref_rec the escalation references attributes used when raising a create escalation reference event
61 * @rep:scope private
62 * @rep:lifecycle active
63 * @rep:displayname Raise Create Escalation References Event
64 * @rep:compatibility S
65 */
66 PROCEDURE publish_create_escref (
67 P_ESC_REF_REC IN Jtf_ec_references_pvt.Esc_Ref_rec
68
69 );
70
71 /*#
72 * Raises the Update Escalation References Event
73 *
74 * @param p_esc_ref_rec_old the old escalation references attributes, existing values
75 * @param p_esc_ref_rec_new the new escalation references attributes, changed values
76 * @rep:scope private
77 * @rep:lifecycle active
78 * @rep:displayname Raise Update Escalation References Event
79 * @rep:compatibility S
80 */
81 PROCEDURE publish_update_escref (
82 P_ESC_REF_REC_OLD IN Jtf_ec_references_pvt.Esc_Ref_rec,
83 P_ESC_REF_REC_NEW IN Jtf_ec_references_pvt.Esc_Ref_rec
84 );
85
86 /*#
87 * Raises the Delete Escalation References Event
88 *
89 * @param p_esc_ref_rec the escalation references attributes used when raising a delete escalation reference event
90 * @rep:scope private
91 * @rep:lifecycle active
92 * @rep:displayname Raise Delete Escalation References Event
93 * @rep:compatibility S
94 */
95 PROCEDURE publish_delete_escref (
96 P_ESC_REF_REC IN Jtf_ec_references_pvt.Esc_Ref_rec
97 );
98
99 /*#
100 * Retrieves the item key for the Business Event
101 *
102 * @param p_event_name the name of the Busines Event
103 * @return the item key for the Business Event
104 * @rep:scope private
105 * @rep:lifecycle active
106 * @rep:displayname Get Item Key
107 * @rep:compatibility S
108
109 */
110 FUNCTION get_item_key(p_event_name IN VARCHAR2)
111 RETURN VARCHAR2;
112
113
114 /*#
115 * Sets the values for the Parameters and add to the WF parameter list while publishing an Event
116 * This is an overloaded procedure used when attribute values are Text
117 *
118 * @param p_attribute_name the attribute used for the Busines Event
119 * @param p_old_value the old value for the attribute - used during update event
120 * @param p_new_value the new value for the attribute - used for all events
121 * @param p_action the parameter to determine the nature of event - Create or Update or Delete
122 * @param p_list the wf parameter list type used to store BES attributes with their values
123 * @param publish_if_change the flag to determine publishing old and new values on an Update Event
124 * @rep:scope private
125 * @rep:lifecycle active
126 * @rep:displayname Set Attributes to List
127 * @rep:compatibility S
128 */
129 PROCEDURE compare_and_set_attr_to_list (
130 P_ATTRIBUTE_NAME IN VARCHAR2,
131 P_OLD_VALUE IN VARCHAR2,
132 P_NEW_VALUE IN VARCHAR2,
133 P_ACTION IN VARCHAR2,
134 P_LIST IN OUT NOCOPY WF_PARAMETER_LIST_T,
135 PUBLISH_IF_CHANGE IN VARCHAR2 DEFAULT 'Y'
136 );
137
138 /*#
139 * Sets the values for the Parameters and add to the WF parameter list while publishing an Event
140 * This is an overloaded procedure used when attribute values are Numeric
141 *
142 * @param p_attribute_name the attribute used for the Busines Event
143 * @param p_old_value the old value for the attribute - used for update event
144 * @param p_new_value the new value for the attribute - used for all events
145 * @param p_action the parameter to determine the nature of event - Create or Update or Delete
146 * @param p_list the wf parameter list type used to store BES attributes with their values
147 * @param publish_if_change the flag to determine publishing old and new values on an Update Event
148 * @rep:scope private
149 * @rep:lifecycle active
150 * @rep:displayname Set Attributes to List
151 * @rep:compatibility S
152 */
153 PROCEDURE compare_and_set_attr_to_list (
154 P_ATTRIBUTE_NAME IN VARCHAR2,
155 P_OLD_VALUE IN NUMBER,
156 P_NEW_VALUE IN NUMBER,
157 P_ACTION IN VARCHAR2,
158 P_LIST IN OUT NOCOPY WF_PARAMETER_LIST_T,
159 PUBLISH_IF_CHANGE IN VARCHAR2 DEFAULT 'Y'
160 );
161
162 /*#
163 * Sets the values for the Parameters and add to the WF parameter list while publishing an Event
164 * This is an overloaded procedure used when attribute values are Dates
165 *
166 * @param p_attribute_name the attribute used for the Busines Event
167 * @param p_old_value the old value for the attribute - used for update event
168 * @param p_new_value the new value for the attribute - used for all events
169 * @param p_action the parameter to determine the nature of event - Create or Update or Delete
170 * @param p_list the wf parameter list type used to store BES attributes with their values
171 * @param publish_if_change the flag to determine publishing old and new values on an Update Event
172 * @rep:scope private
173 * @rep:lifecycle active
174 * @rep:displayname Set Attributes to List
175 * @rep:compatibility S
176 */
177 PROCEDURE compare_and_set_attr_to_list (
178 P_ATTRIBUTE_NAME IN VARCHAR2,
179 P_OLD_VALUE IN DATE,
180 P_NEW_VALUE IN DATE,
181 P_ACTION IN VARCHAR2,
182 P_LIST IN OUT NOCOPY WF_PARAMETER_LIST_T,
183 PUBLISH_IF_CHANGE IN VARCHAR2 DEFAULT 'Y'
184 );
185
186
187 END;