DBA Data[Home] [Help]

PACKAGE: APPS.JTF_TASK_PHONES_PUB

Source


1 PACKAGE jtf_task_phones_pub AS
2 /* $Header: jtfptkps.pls 120.1 2005/07/02 00:59:54 appldev ship $ */
3 /*#
4  * This is the public package to validate, crete, update, and delete task phones.
5  *
6  * @rep:scope internal
7  * @rep:product CAC
8  * @rep:lifecycle active
9  * @rep:displayname Task Phone
10  * @rep:compatibility S
11  * @rep:category BUSINESS_ENTITY CAC_CAL_TASK
12  */
13 
14 
15    TYPE task_phones_rec IS RECORD (
16       task_phone_id                 NUMBER,
17       task_contact_id               NUMBER,
18       phone_id                      NUMBER,
19       object_version_number         NUMBER,
20       attribute1                    VARCHAR2(150),
21       attribute2                    VARCHAR2(150),
22       attribute3                    VARCHAR2(150),
23       attribute4                    VARCHAR2(150),
24       attribute5                    VARCHAR2(150),
25       attribute6                    VARCHAR2(150),
26       attribute7                    VARCHAR2(150),
27       attribute8                    VARCHAR2(150),
28       attribute9                    VARCHAR2(150),
29       attribute10                   VARCHAR2(150),
30       attribute11                   VARCHAR2(150),
31       attribute12                   VARCHAR2(150),
32       attribute13                   VARCHAR2(150),
33       attribute14                   VARCHAR2(150),
34       attribute15                   VARCHAR2(150),
35       attribute_category            VARCHAR2(30),
36       owner_table_name              VARCHAR2(30),
37       primary_flag                  VARCHAR2(1)
38    );
39 
40    p_task_phones_rec   task_phones_rec;
41 
42 /*#
43  * Task phones creation API.
44  *
45  * @param p_api_version the standard API version number
46  * @param p_init_msg_list the standard API flag allows API callers to request
47  * that the API does the initialization of the message list on their behalf.
48  * By default, the message list will not be initialized.
49  * @param p_commit the standard API flag is used by API callers to ask
50  * the API to commit on their behalf after performing its function
51  * By default, the commit will not be performed.
52  * @param p_task_contact_id the task contact id for task phone creation
53  * @param p_phone_id the phone id for task phone creation
54  * @param x_task_phone_id the task phone id being created
55  * @param x_return_status returns the result of all the operations performed
56  * by the API and must have one of the following values:
57  *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
58  *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
59  *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
60  * @param x_msg_data returns the message in an encoded format if
61  * <code>x_msg_count</code> returns number one.
62  * @param x_msg_count returns the number of messages in the API message list
63  * @param p_attribute1 attribute1 for flexfield
64  * @param p_attribute2 attribute2 for flexfield
65  * @param p_attribute3 attribute3 for flexfield
66  * @param p_attribute4 attribute4 for flexfield
67  * @param p_attribute5 attribute5 for flexfield
68  * @param p_attribute6 attribute6 for flexfield
69  * @param p_attribute7 attribute7 for flexfield
70  * @param p_attribute8 attribute8 for flexfield
71  * @param p_attribute9 attribute9 for flexfield
72  * @param p_attribute10 attribute10 for flexfield
73  * @param p_attribute11 attribute11 for flexfield
74  * @param p_attribute12 attribute12 for flexfield
75  * @param p_attribute13 attribute13 for flexfield
76  * @param p_attribute14 attribute14 for flexfield
77  * @param p_attribute15 attribute15 for flexfield
78  * @param p_attribute_category attribute category
79  * @param p_owner_table_name the owner table name for task phone creation
80  * @param p_primary_flag the primary flag for task phone creation
81  * @paraminfo {@rep:precision 6000}
82  * @rep:scope internal
83  * @rep:lifecycle active
84  * @rep:displayname Create Task Phone
85  * @rep:compatibility S
86  */
87    PROCEDURE create_task_phones (
88       p_api_version          IN       NUMBER,
89       p_init_msg_list        IN       VARCHAR2 DEFAULT fnd_api.g_false,
90       p_commit               IN       VARCHAR2 DEFAULT fnd_api.g_false,
91       p_task_contact_id      IN       NUMBER,
92       p_phone_id             IN       NUMBER,
93       x_task_phone_id        OUT NOCOPY      NUMBER,
94       x_return_status        OUT NOCOPY      VARCHAR2,
95       x_msg_data             OUT NOCOPY      VARCHAR2,
96       x_msg_count            OUT NOCOPY      NUMBER,
97       p_attribute1           IN       VARCHAR2 DEFAULT NULL,
98       p_attribute2           IN       VARCHAR2 DEFAULT NULL,
99       p_attribute3           IN       VARCHAR2 DEFAULT NULL,
100       p_attribute4           IN       VARCHAR2 DEFAULT NULL,
101       p_attribute5           IN       VARCHAR2 DEFAULT NULL,
102       p_attribute6           IN       VARCHAR2 DEFAULT NULL,
103       p_attribute7           IN       VARCHAR2 DEFAULT NULL,
104       p_attribute8           IN       VARCHAR2 DEFAULT NULL,
105       p_attribute9           IN       VARCHAR2 DEFAULT NULL,
106       p_attribute10          IN       VARCHAR2 DEFAULT NULL,
107       p_attribute11          IN       VARCHAR2 DEFAULT NULL,
108       p_attribute12          IN       VARCHAR2 DEFAULT NULL,
109       p_attribute13          IN       VARCHAR2 DEFAULT NULL,
110       p_attribute14          IN       VARCHAR2 DEFAULT NULL,
111       p_attribute15          IN       VARCHAR2 DEFAULT NULL,
112       p_attribute_category   IN       VARCHAR2 DEFAULT NULL,
113       p_owner_table_name     IN       VARCHAR2 DEFAULT 'JTF_TASK_CONTACTS',
114       p_primary_flag         IN       VARCHAR2 DEFAULT NULL
115    );
116 
117 /*#
118  * Task phone row locking API.
119  *
120  * @param p_api_version the standard API version number
121  * @param p_init_msg_list the standard API flag allows API callers to request
122  * that the API does the initialization of the message list on their behalf.
123  * By default, the message list will not be initialized.
124  * @param p_commit the standard API flag is used by API callers to ask
125  * the API to commit on their behalf after performing its function
126  * By default, the commit will not be performed.
127  * @param p_task_phone_id the task phone id being locked
128  * @param p_object_version_number the object version number for lock
129  * @param x_return_status returns the result of all the operations performed
130  * by the API and must have one of the following values:
131  *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
132  *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
133  *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
134  * @param x_msg_data returns the message in an encoded format if
135  * <code>x_msg_count</code> returns number one.
136  * @param x_msg_count returns the number of messages in the API message list
137  * @paraminfo {@rep:precision 6000}
138  * @rep:scope private
139  * @rep:lifecycle active
140  * @rep:displayname Lock Task Phone
141  * @rep:compatibility S
142  */
143    PROCEDURE lock_task_phones (
144       p_api_version             IN       NUMBER,
145       p_init_msg_list           IN       VARCHAR2 DEFAULT fnd_api.g_false,
146       p_commit                  IN       VARCHAR2 DEFAULT fnd_api.g_false,
147       p_task_phone_id           IN       NUMBER,
148       p_object_version_number   IN       NUMBER,
149       x_return_status           OUT NOCOPY      VARCHAR2,
150       x_msg_data                OUT NOCOPY      VARCHAR2,
151       x_msg_count               OUT NOCOPY      NUMBER
152    );
153 
154 
155 /*#
156  * Task phones update API.
157  *
158  * @param p_api_version the standard API version number
159  * @param p_init_msg_list the standard API flag allows API callers to request
160  * that the API does the initialization of the message list on their behalf.
161  * By default, the message list will not be initialized.
162  * @param p_commit the standard API flag is used by API callers to ask
163  * the API to commit on their behalf after performing its function
164  * By default, the commit will not be performed.
165  * @param p_object_version_number the object version number for task phone update
166  * @param p_task_phone_id the task phone id for task phone update
167  * @param p_phone_id the phone id for task phone update
168  * @param x_return_status returns the result of all the operations performed
169  * by the API and must have one of the following values:
170  *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
171  *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
172  *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
173  * @param x_msg_data returns the message in an encoded format if
174  * <code>x_msg_count</code> returns number one.
175  * @param x_msg_count returns the number of messages in the API message list
176  * @param p_attribute1 attribute1 for flexfield
177  * @param p_attribute2 attribute2 for flexfield
178  * @param p_attribute3 attribute3 for flexfield
179  * @param p_attribute4 attribute4 for flexfield
180  * @param p_attribute5 attribute5 for flexfield
181  * @param p_attribute6 attribute6 for flexfield
182  * @param p_attribute7 attribute7 for flexfield
183  * @param p_attribute8 attribute8 for flexfield
184  * @param p_attribute9 attribute9 for flexfield
185  * @param p_attribute10 attribute10 for flexfield
186  * @param p_attribute11 attribute11 for flexfield
187  * @param p_attribute12 attribute12 for flexfield
188  * @param p_attribute13 attribute13 for flexfield
189  * @param p_attribute14 attribute14 for flexfield
190  * @param p_attribute15 attribute15 for flexfield
191  * @param p_attribute_category attribute category
192  * @param p_primary_flag the primary flag for task phone update
193  * @paraminfo {@rep:precision 6000}
194  * @rep:scope internal
195  * @rep:lifecycle active
196  * @rep:displayname Update Task Phone
197  * @rep:compatibility S
198  */
199    PROCEDURE update_task_phones (
200       p_api_version             IN       NUMBER,
201       p_init_msg_list           IN       VARCHAR2 DEFAULT fnd_api.g_false,
202       p_commit                  IN       VARCHAR2 DEFAULT fnd_api.g_false,
203       p_object_version_number   IN OUT NOCOPY   NUMBER,
204       p_task_phone_id           IN       NUMBER,
205       p_phone_id                IN       NUMBER,
206       x_return_status           OUT NOCOPY      VARCHAR2,
207       x_msg_data                OUT NOCOPY      VARCHAR2,
208       x_msg_count               OUT NOCOPY      NUMBER,
209       p_attribute1              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
210       p_attribute2              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
211       p_attribute3              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
212       p_attribute4              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
213       p_attribute5              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
214       p_attribute6              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
215       p_attribute7              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
216       p_attribute8              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
217       p_attribute9              IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
218       p_attribute10             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
219       p_attribute11             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
220       p_attribute12             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
221       p_attribute13             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
222       p_attribute14             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
223       p_attribute15             IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
224       p_attribute_category      IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char,
225       p_primary_flag            IN       VARCHAR2 DEFAULT jtf_task_utl.g_miss_char
226    );
227 
228 /*#
229  * Task phone delete API.
230  *
231  * @param p_api_version the standard API version number
232  * @param p_init_msg_list the standard API flag allows API callers to request
233  * that the API does the initialization of the message list on their behalf.
234  * By default, the message list will not be initialized.
235  * @param p_commit the standard API flag is used by API callers to ask
236  * the API to commit on their behalf after performing its function
237  * By default, the commit will not be performed.
238  * @param p_object_version_number the object version number for delete
239  * @param p_task_phone_id the task phone id being deleted
240  * @param x_return_status returns the result of all the operations performed
241  * by the API and must have one of the following values:
242  *   <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
243  *   <LI><Code>FND_API.G_RET_STS_ERROR</Code>
244  *   <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
245  * @param x_msg_count returns the number of messages in the API message list
246  * @param x_msg_data returns the message in an encoded format if
247  * <code>x_msg_count</code> returns number one.
248  * @paraminfo {@rep:precision 6000}
249  * @rep:scope internal
250  * @rep:lifecycle active
251  * @rep:displayname Delete Task Phone
252  * @rep:compatibility S
253  */
254 
255    PROCEDURE delete_task_phones (
256       p_api_version             IN       NUMBER,
257       p_init_msg_list           IN       VARCHAR2 DEFAULT fnd_api.g_false,
258       p_commit                  IN       VARCHAR2 DEFAULT fnd_api.g_false,
259       p_object_version_number   IN       NUMBER,
260       p_task_phone_id           IN       NUMBER,
261       x_return_status           OUT NOCOPY      VARCHAR2,
262       x_msg_data                OUT NOCOPY      VARCHAR2,
263       x_msg_count               OUT NOCOPY      NUMBER
264    );
265 END;