[Home] [Help]
PACKAGE: APPS.HZ_CONTACT_PREFERENCE_V2PUB
Source
1 PACKAGE HZ_CONTACT_PREFERENCE_V2PUB AS
2 /* $Header: ARH2CTSS.pls 120.7 2006/08/17 10:16:10 idali noship $ */
3 /*#
4 * This package contains the public APIs for contact preference.
5 * @rep:scope public
6 * @rep:product HZ
7 * @rep:displayname Contact Preference
8 * @rep:category BUSINESS_ENTITY HZ_CONTACT_PREFERENCE
9 * @rep:lifecycle active
10 * @rep:doccd 120hztig.pdf Contact Preference APIs, Oracle Trading Community Architecture Technical Implementation Guide
11 */
12
13 TYPE contact_preference_rec_type IS RECORD (
14
15 contact_preference_id NUMBER,
16 contact_level_table VARCHAR2(30),
17 contact_level_table_id NUMBER,
18 contact_type VARCHAR2(30),
19 preference_code VARCHAR2(30),
20 preference_topic_type VARCHAR2(30),
21 preference_topic_type_id NUMBER,
22 preference_topic_type_code VARCHAR2(30),
23 preference_start_date DATE,
24 preference_end_date DATE,
25 preference_start_time_hr NUMBER,
26 preference_end_time_hr NUMBER,
27 preference_start_time_mi NUMBER,
28 preference_end_time_mi NUMBER,
29 max_no_of_interactions NUMBER,
30 max_no_of_interact_uom_code VARCHAR2(30),
31 requested_by VARCHAR2(30),
32 reason_code VARCHAR2(30),
33 status VARCHAR2(1),
34 created_by_module VARCHAR2(150),
35 application_id NUMBER
36
37 );
38
39 --------------------------------------
40 -- declaration of public procedures and functions
41 --------------------------------------
42
43 /**
44 * PROCEDURE create_contact_preference
45 *
46 * DESCRIPTION
47 * Creates contact preference
48 *
49 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
50 *
51 * ARGUMENTS
52 * IN:
53 * p_init_msg_list Initialize message stack if it is set to
54 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
55 * p_contact_preference_rec Contact preference record.
56 * IN/OUT:
57 * OUT:
58 * x_contact_preference_id contact preference ID.
59 * x_return_status Return status after the call. The status can
60 * be FND_API.G_RET_STS_SUCCESS (success),
61 * FND_API.G_RET_STS_ERROR (error),
62 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
63 * x_msg_count Number of messages in message stack.
64 * x_msg_data Message text if x_msg_count is 1.
65 *
66 * NOTES
67 *
68 * MODIFICATION HISTORY
69 *
70 * 23-JUL-2001 Kate Shan o Created.
71 *
72 */
73
74 /*#
75 * Use this routine to create a contact preference. This API creates records in the
76 * HZ_CONTACT_PREFERENCES table. You can create contact preferences for a party, party
77 * site, or contact point.
78 * @rep:scope public
79 * @rep:lifecycle active
80 * @rep:displayname Create Contact Preference
81 * @rep:businessevent oracle.apps.ar.hz.ContactPreference.create
82 * @rep:doccd 120hztig.pdf Contact Preference APIs, Oracle Trading Community Architecture Technical Implementation Guide
83 */
84 PROCEDURE create_contact_preference (
85 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
86 p_contact_preference_rec IN CONTACT_PREFERENCE_REC_TYPE,
87 x_contact_preference_id OUT NOCOPY NUMBER,
88 x_return_status OUT NOCOPY VARCHAR2,
89 x_msg_count OUT NOCOPY NUMBER,
90 x_msg_data OUT NOCOPY VARCHAR2
91 );
92
93 /**
94 * PROCEDURE update_contact_preference
95 *
96 * DESCRIPTION
97 * Updates contact preference
98 *
99 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
100 *
101 * ARGUMENTS
102 * IN:
103 * p_init_msg_list Initialize message stack if it is set to
104 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
105 * p_contact_preference_rec Contact Preference record.
106 * IN/OUT:
107 * p_object_version_number Used for locking the being updated record.
108 * OUT:
109 * x_return_status Return status after the call. The status can
110 * be FND_API.G_RET_STS_SUCCESS (success),
111 * FND_API.G_RET_STS_ERROR (error),
112 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
113 * x_msg_count Number of messages in message stack.
114 * x_msg_data Message text if x_msg_count is 1.
115 *
116 * NOTES
117 *
118 * MODIFICATION HISTORY
119 *
120 * 07-23-2001 Kate Shan o Created.
121 *
122 */
123
124 /*#
125 * Use this routine to update a contact preference. This API updates records in the
126 * HZ_CONTACT_PREFERENCES table for a party, party site or contact point.
127 * @rep:scope public
128 * @rep:lifecycle active
129 * @rep:displayname Update Contact Preference
130 * @rep:businessevent oracle.apps.ar.hz.ContactPreference.update
131 * @rep:doccd 120hztig.pdf Contact Preference APIs, Oracle Trading Community Architecture Technical Implementation Guide
132 */
133 PROCEDURE update_contact_preference (
134 p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE,
135 p_contact_preference_rec IN CONTACT_PREFERENCE_REC_TYPE,
136 p_object_version_number IN OUT NOCOPY NUMBER,
137 x_return_status OUT NOCOPY VARCHAR2,
138 x_msg_count OUT NOCOPY NUMBER,
139 x_msg_data OUT NOCOPY VARCHAR2
140 );
141
142 /**
143 * PROCEDURE get_contact_preference_rec
144 *
145 * DESCRIPTION
146 * Gets contact preference record
147 *
148 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
149 *
150 * ARGUMENTS
151 * IN:
152 * p_init_msg_list Initialize message stack if it is set to
153 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
154 * p_contact_preference_id Contact preference id.
155 * IN/OUT:
156 * OUT:
157 * x_contact_preference_rec Returned contact preference record.
158 * x_return_status Return status after the call. The status can
159 * be FND_API.G_RET_STS_SUCCESS (success),
160 * FND_API.G_RET_STS_ERROR (error),
161 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
162 * x_msg_count Number of messages in message stack.
163 * x_msg_data Message text if x_msg_count is 1.
164 *
165 * NOTES
166 *
167 * MODIFICATION HISTORY
168 *
169 * 07-23-2001 Kate Shan o Created.
170 *
171 */
172
173 PROCEDURE get_contact_preference_rec (
174 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
175 p_contact_preference_id IN NUMBER,
176 x_contact_preference_rec OUT NOCOPY CONTACT_PREFERENCE_REC_TYPE,
177 x_return_status OUT NOCOPY VARCHAR2,
178 x_msg_count OUT NOCOPY NUMBER,
179 x_msg_data OUT NOCOPY VARCHAR2
180 );
181
182
183 END HZ_CONTACT_PREFERENCE_V2PUB;