DBA Data[Home] [Help]

PACKAGE: APPS.JTF_EC_REFERENCES_PVT

Source


1 PACKAGE jtf_ec_references_pvt   AS
2 /* $Header: jtfecres.pls 120.1 2005/07/02 00:41:32 appldev ship $ */
3 /*#
4  * This is the private interface to the JTF Escalation Management.
5  * This Interface is used to Create / Update / Delete References for
6  * the escalations.
7  *
8  * @rep:scope private
9  * @rep:product JTF
10  * @rep:lifecycle active
11  * @rep:displayname Escalation Management
12  * @rep:compatibility S
13  * @rep:category BUSINESS_ENTITY JTA_ESCALATION
14 */
15 
16 /*#
17 * Creates an Escalation Reference.  After successful creation, triggers the BES for
18 * create escalation reference event.
19 *
20 * @param p_api_version the standard API version number
21 * @param p_init_msg_list the standard API flag allows API callers to request
22 * that the API does the initialization of the message list on their behalf.
23 * By default, the message list will not be initialized.
24 * @param p_commit the standard API flag is used by API callers to ask
25 * the API to commit on their behalf after performing its function
26 * By default, the commit will not be performed.
27 * @param p_escalation_id the escalation id
28 * @param p_escalation_number the escalation number
29 * @param p_object_type_code the refernce object type code
30 * @param p_object_name the reference object name
31 * @param p_object_id the reference object id
32 * @param p_object_details the reference object details
33 * @param p_reference_code the reference code eg. esc for escalations
34 * @param p_usage the usage for reference creation
35 * @param x_return_status the parameter that returns the result of all the operations performed.
36 * by the API and must have one of the following values:
37 *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
38 *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
39 *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
40 * @param x_msg_data the parameter that returns the FND Message in encoded format.
41 * @param x_msg_count the parameter that returns the number of messages in the FND message list.
42 * @param x_escalation_reference_id the parameter that returns the Escalation reference ID
43 * @param p_attribute1 the value of the flex field attribute1
44 * @param p_attribute2 the value of the flex field attribute2
45 * @param p_attribute3 the value of the flex field attribute3
46 * @param p_attribute4 the value of the flex field attribute4
47 * @param p_attribute5 the value of the flex field attribute5
48 * @param p_attribute6 the value of the flex field attribute6
49 * @param p_attribute7 the value of the flex field attribute7
50 * @param p_attribute8 the value of the flex field attribute8
51 * @param p_attribute9 the value of the flex field attribute9
52 * @param p_attribute10 the value of the flex field attribute10
53 * @param p_attribute11 the value of the flex field attribute11
54 * @param p_attribute12 the value of the flex field attribute12
55 * @param p_attribute13 the value of the flex field attribute13
56 * @param p_attribute14 the value of the flex field attribute14
57 * @param p_attribute15 the value of the flex field attribute15
58 * @param p_attribute_category the value of the flex field attribute category
59 * @rep:scope private
60 * @rep:lifecycle active
61 * @rep:displayname Create Escalation Reference
62 * @rep:compatibility S
63 */
64    PROCEDURE create_references (
65       p_api_version               IN       NUMBER,
66       p_init_msg_list             IN       VARCHAR2 DEFAULT fnd_api.g_false,
67       p_commit                    IN       VARCHAR2 DEFAULT fnd_api.g_false,
68       p_escalation_id             IN       NUMBER DEFAULT NULL,
69       p_escalation_number         IN       VARCHAR2 DEFAULT NULL,
70       p_object_type_code          IN       VARCHAR2,
71       p_object_name               IN       VARCHAR2,
72       p_object_id                 IN       NUMBER,
73       p_object_details            IN       VARCHAR2 DEFAULT NULL,
74       p_reference_code            IN       VARCHAR2 DEFAULT NULL,
75       p_usage                     IN       VARCHAR2 DEFAULT NULL,
76       x_return_status             OUT NOCOPY     VARCHAR2,
77       x_msg_data                  OUT NOCOPY     VARCHAR2,
78       x_msg_count                 OUT NOCOPY     NUMBER,
79       x_escalation_reference_id   OUT NOCOPY     NUMBER,
80       p_attribute1                IN       VARCHAR2 DEFAULT null ,
81       p_attribute2                IN       VARCHAR2 DEFAULT null ,
82       p_attribute3                IN       VARCHAR2 DEFAULT null ,
83       p_attribute4                IN       VARCHAR2 DEFAULT null ,
84       p_attribute5                IN       VARCHAR2 DEFAULT null ,
85       p_attribute6                IN       VARCHAR2 DEFAULT null ,
86       p_attribute7                IN       VARCHAR2 DEFAULT null ,
87       p_attribute8                IN       VARCHAR2 DEFAULT null ,
88       p_attribute9                IN       VARCHAR2 DEFAULT null ,
89       p_attribute10               IN       VARCHAR2 DEFAULT null ,
90       p_attribute11               IN       VARCHAR2 DEFAULT null ,
91       p_attribute12               IN       VARCHAR2 DEFAULT null ,
92       p_attribute13               IN       VARCHAR2 DEFAULT null ,
93       p_attribute14               IN       VARCHAR2 DEFAULT null ,
94       p_attribute15               IN       VARCHAR2 DEFAULT null ,
95       p_attribute_category        IN       VARCHAR2 DEFAULT null
96 
97    );
98 
99 /*#
100 * Updates an Escalation Reference.  After successful updation, triggers the BES for
101 * update escalation reference event.
102 *
103 * @param p_api_version the standard API version number
104 * @param p_init_msg_list the standard API flag allows API callers to request
105 * that the API does the initialization of the message list on their behalf.
106 * By default, the message list will not be initialized.
107 * @param p_commit the standard API flag is used by API callers to ask
108 * the API to commit on their behalf after performing its function
109 * By default, the commit will not be performed.
110 * @param p_object_version_number the object version number of the escalation reference record
111 * @param p_escalation_reference_id the escalation reference id
112 * @param p_object_type_code the reference object type code
113 * @param p_object_name the reference object name
114 * @param p_object_id the reference object id
115 * @param p_object_details the reference object details
116 * @param p_reference_code the reference code eg. esc for escalations
117 * @param p_usage the usage for reference creation
118 * @param x_return_status the parameter that returns the result of all the operations performed.
119 * by the API and must have one of the following values:
120 *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
121 *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
122 *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
123 * @param x_msg_data the parameter that returns the FND Message in encoded format.
124 * @param x_msg_count the parameter that returns the number of messages in the FND message list.
125 * @param p_attribute1 the value of the flex field attribute1
126 * @param p_attribute2 the value of the flex field attribute2
127 * @param p_attribute3 the value of the flex field attribute3
128 * @param p_attribute4 the value of the flex field attribute4
129 * @param p_attribute5 the value of the flex field attribute5
130 * @param p_attribute6 the value of the flex field attribute6
131 * @param p_attribute7 the value of the flex field attribute7
132 * @param p_attribute8 the value of the flex field attribute8
133 * @param p_attribute9 the value of the flex field attribute9
134 * @param p_attribute10 the value of the flex field attribute10
135 * @param p_attribute11 the value of the flex field attribute11
136 * @param p_attribute12 the value of the flex field attribute12
137 * @param p_attribute13 the value of the flex field attribute13
138 * @param p_attribute14 the value of the flex field attribute14
139 * @param p_attribute15 the value of the flex field attribute15
140 * @param p_attribute_category the value of the flex field attribute category
141 * @param p_task_id the escalation id
142 * @rep:scope private
143 * @rep:lifecycle active
144 * @rep:displayname Update Escalation Reference
145 * @rep:compatibility S
146 */
147    PROCEDURE update_references (
148       p_api_version               IN       NUMBER,
149       p_init_msg_list             IN       VARCHAR2 DEFAULT fnd_api.g_false,
150       p_commit                    IN       VARCHAR2 DEFAULT fnd_api.g_false,
151       p_object_version_number     IN OUT NOCOPY  NUMBER,
152       p_escalation_reference_id   IN       NUMBER,
153       p_object_type_code          IN       VARCHAR2 DEFAULT fnd_api.g_miss_char,
154       p_object_name               IN       VARCHAR2 DEFAULT fnd_api.g_miss_char,
155       p_object_id                 IN       NUMBER DEFAULT fnd_api.g_miss_num,
156       p_object_details            IN       VARCHAR2 DEFAULT fnd_api.g_miss_char,
157       p_reference_code            IN       VARCHAR2 DEFAULT fnd_api.g_miss_char,
158       p_usage                     IN       VARCHAR2 DEFAULT fnd_api.g_miss_char,
159       x_return_status             OUT NOCOPY     VARCHAR2,
160       x_msg_data                  OUT NOCOPY     VARCHAR2,
161       x_msg_count                 OUT NOCOPY     NUMBER,
162       p_attribute1                IN       VARCHAR2 DEFAULT null ,
163       p_attribute2                IN       VARCHAR2 DEFAULT null ,
164       p_attribute3                IN       VARCHAR2 DEFAULT null ,
165       p_attribute4                IN       VARCHAR2 DEFAULT null ,
166       p_attribute5                IN       VARCHAR2 DEFAULT null ,
167       p_attribute6                IN       VARCHAR2 DEFAULT null ,
168       p_attribute7                IN       VARCHAR2 DEFAULT null ,
169       p_attribute8                IN       VARCHAR2 DEFAULT null ,
170       p_attribute9                IN       VARCHAR2 DEFAULT null ,
171       p_attribute10               IN       VARCHAR2 DEFAULT null ,
172       p_attribute11               IN       VARCHAR2 DEFAULT null ,
173       p_attribute12               IN       VARCHAR2 DEFAULT null ,
174       p_attribute13               IN       VARCHAR2 DEFAULT null ,
175       p_attribute14               IN       VARCHAR2 DEFAULT null ,
176       p_attribute15               IN       VARCHAR2 DEFAULT null ,
177       p_attribute_category        IN       VARCHAR2 DEFAULT null ,
178       p_task_id			  IN	   NUMBER DEFAULT fnd_api.g_miss_num
179    );
180 
181 
182 /*#
183 * Deletes an Escalation Reference.  After successful deletion, triggers the BES for
184 * delete escalation reference event.
185 *
186 * @param p_api_version the standard API version number
187 * @param p_init_msg_list the standard API flag allows API callers to request
188 * that the API does the initialization of the message list on their behalf.
189 * By default, the message list will not be initialized.
190 * @param p_commit the standard API flag is used by API callers to ask
191 * the API to commit on their behalf after performing its function
192 * By default, the commit will not be performed.
193 * @param p_object_version_number the object version number of the escalation reference record
194 * @param p_escalation_reference_id the escalation reference id
195 * @param x_return_status the parameter that returns the result of all the operations performed.
196 * by the API and must have one of the following values:
197 *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
198 *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
199 *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
200 * @param x_msg_data the parameter that returns the FND Message in encoded format.
201 * @param x_msg_count the parameter that returns the number of messages in the FND message list.
202 * @rep:scope private
203 * @rep:lifecycle active
204 * @rep:displayname Update Escalation Reference
205 * @rep:compatibility S
206 */
207    PROCEDURE delete_references (
208       p_api_version               IN       NUMBER,
209       p_init_msg_list             IN       VARCHAR2 DEFAULT fnd_api.g_false,
210       p_commit                    IN       VARCHAR2 DEFAULT fnd_api.g_false,
211       p_object_version_number     IN       NUMBER,
212       p_escalation_reference_id   IN       NUMBER,
213       x_return_status             OUT NOCOPY     VARCHAR2,
214       x_msg_data                  OUT NOCOPY     VARCHAR2,
215       x_msg_count                 OUT NOCOPY     NUMBER
216    );
217 
218 --Created for BES enh 2660883
219 
220 TYPE Esc_Ref_rec IS RECORD (
221 	TASK_REFERENCE_ID	JTF_TASK_REFERENCES_B.TASK_REFERENCE_ID%TYPE := FND_API.G_MISS_NUM,
222 	OBJECT_TYPE_CODE 	JTF_TASK_REFERENCES_B.OBJECT_TYPE_CODE%TYPE := FND_API.G_MISS_CHAR,
223 	REFERENCE_CODE		JTF_TASK_REFERENCES_B.REFERENCE_CODE%TYPE := FND_API.G_MISS_CHAR,
224 	OBJECT_ID		JTF_TASK_REFERENCES_B.OBJECT_ID%TYPE := FND_API.G_MISS_NUM,
225 	TASK_ID			JTF_TASK_REFERENCES_B.TASK_ID%TYPE := FND_API.G_MISS_NUM
226 	);
227 
228 END;