1 Package ota_chat_api AUTHID CURRENT_USER as
2 /* $Header: otchaapi.pkh 120.5 2006/07/13 11:54:28 niarora noship $ */
3 /*#
4 * This package contains chat related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Chats
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------------< create_chat >----------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new Chat.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Learning Management.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The Business group must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The Chat is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a chat record, and raises an error.
30 *
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_effective_date Reference date for validating that lookup values are
35 * applicable during the start to end active date range. This date does not
36 * determine when the changes take effect.
37 * @param p_business_group_id The unique identifier of the business group that owns this chat.
38 * @param p_name The name of the chat.
39 * @param p_description The description for the chat.
40 * @param p_start_date_active The date on which the learners can begin to subscribe to and
41 * enter the category chat or the date on which the learners can enter the class chat.
42 * @param p_end_date_active The date on which the chat becomes no longer available to learners.
43 * @param p_start_time_active The time from which the learners can begin to subscribe to and enter
44 * the category chat or the date on which the learners can enter the class chat.
45 * @param p_end_time_active The time after which the chat becomes no longer available to learners.
46 * @param p_timezone_code Time Zone code of the Chat. Foreign key to FND_TIMEZONES_B table.
47 * @param p_public_flag Indicates whether the chat is public. Permissible values are 'Y' and 'N'.
48 * @param p_chat_id The unique identifier for the chat record.
49 * @param p_object_version_number If p_validate is false, then set to the version number of the
50 * created chat. If p_validate is true, then the value will be null.
51 * @rep:displayname Create Chat
52 * @rep:category BUSINESS_ENTITY OTA_CHAT
53 * @rep:lifecycle active
54 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
55 * @rep:scope public
56 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
57 */
58 --
59 -- {End Of Comments}
60 --
61 procedure create_chat (
62 p_validate in boolean default false
63 ,p_effective_date in date
64 ,p_name in varchar2
65 ,p_description in varchar2 default null
66 ,p_business_group_id in number
67 ,p_start_date_active in date default null
68 ,p_end_date_active in date default null
69 ,p_start_time_active in varchar2 default null
70 ,p_end_time_active in varchar2 default NULL
71 ,p_timezone_code in varchar2 default null
72 ,p_public_flag in varchar2 default 'N'
73 ,p_chat_id out nocopy number
74 ,p_object_version_number out nocopy number
75 );
76
77 --
78 -- ----------------------------------------------------------------------------
79 -- |-------------------------------< update_chat >----------------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates the chat.
85 *
86 *
87 * <p><b>Licensing</b><br>
88 * This API is licensed for use with Learning Management.
89 *
90 * <p><b>Prerequisites</b><br>
91 * The chat record with the given object version number should exist.
92 *
93 * <p><b>Post Success</b><br>
94 * The chat is updated successfully.
95 *
96 * <p><b>Post Failure</b><br>
97 * The API does not update the chat record, and raises an error.
98 *
99 * @param p_validate If true, then validation alone will be performed and the
100 * database will remain unchanged. If false and all validation checks pass,
101 * then the database will be modified.
102 * @param p_effective_date Reference date for validating that lookup values are applicable
103 * during the start to end active date range. This date does not determine
104 * when the changes take effect.
105 * @param p_name The name of the chat.
106 * @param p_description The description for the chat.
107 * @param p_business_group_id The unique identifier of the business group that owns this chat.
108 * @param p_start_date_active The date on which the learners can begin to subscribe to and enter
109 * the category chat or the date on which the learners can enter the class chat.
110 * @param p_end_date_active The date on which the chat becomes no longer available to learners.
111 * @param p_start_time_active The time from which the learners can begin to subscribe to and
112 * enter the category chat or the date on which the learners can enter the class chat.
113 * @param p_end_time_active The time after which the chat becomes no longer available to learners.
114 * @param p_timezone_code Time Zone code of the Chat. Foreign key to FND_TIMEZONES_B table.
115 * @param p_public_flag Indicates whether the chat is public. Permissible values are 'Y' and 'N'.
116 * @param p_chat_id The unique identifier for the chat record.
117 * @param p_object_version_number Pass in the current version number of the chat to be
118 * updated. When the API completes if p_validate is false, will be set to the new version
119 * number of the updated chat. If p_validate is true will be set to the same value which was passed in.
120 * @rep:displayname Update Chat
121 * @rep:category BUSINESS_ENTITY OTA_CHAT
122 * @rep:lifecycle active
123 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
124 * @rep:scope public
125 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
126 */
127 --
128 -- {End Of Comments}
129 --
130 procedure update_chat
131 (p_validate in boolean default false
132 ,p_effective_date in date
133 ,p_name in varchar2
134 ,p_description in varchar2
135 ,p_business_group_id in number
136 ,p_start_date_active in date default hr_api.g_date
137 ,p_end_date_active in date default hr_api.g_date
138 ,p_start_time_active in varchar2 default hr_api.g_varchar2
139 ,p_end_time_active in varchar2 default hr_api.g_varchar2
140 ,p_timezone_code IN VARCHAR2 DEFAULT hr_api.g_varchar2
141 ,p_public_flag in varchar2 default hr_api.g_varchar2
142 ,p_chat_id in number
143 ,p_object_version_number in out nocopy number);
144 --
145 -- ----------------------------------------------------------------------------
146 -- |-------------------------------< delete_chat >----------------------------|
147 -- ----------------------------------------------------------------------------
148 --
149 -- {Start Of Comments}
150 /*#
151 * This API deletes the chat.
152 *
153 *
154 * <p><b>Licensing</b><br>
155 * This API is licensed for use with Learning Management.
156 *
157 * <p><b>Prerequisites</b><br>
158 * The chat record with the given object version number should exist.
159 *
160 * <p><b>Post Success</b><br>
161 * The chat is deleted successfully.
162 *
163 * <p><b>Post Failure</b><br>
164 * The API does not delete the chat record, and raises an error.
165 *
166 * @param p_validate If true, then validation alone will be performed and the
167 * database will remain unchanged. If false and all validation checks pass,
168 * then the database will be modified.
169 * @param p_chat_id The unique identifier for the chat record.
170 * @param p_object_version_number Current version number of the chat to be deleted.
171 * @rep:displayname Delete Chat
172 * @rep:category BUSINESS_ENTITY OTA_CHAT
173 * @rep:lifecycle active
174 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
175 * @rep:scope public
176 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
177 */
178 --
179 -- {End Of Comments}
180 --
181
182 procedure delete_chat
183 (p_validate in boolean default false
184 ,p_chat_id in number
185 ,p_object_version_number in number
186 );
187
188 end ota_chat_api;
189 --
[Home] [Help]