1 Package ota_chat_message_api as
2 /*$Header: otcmsapi.pkh 120.4 2006/07/13 11:58:44 niarora noship $*/
3 /*#
4 * This package contains chat messages related APIs.
5 * @rep:scope public
6 * @rep:product OTA
7 * @rep:displayname Chat Message
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_chat_message >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the chat message.
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 chat record with which the message is associated must exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The chat message is created successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create a chat message 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 message.
38 * @param p_chat_id Identifies the chat for which the message is posted.
39 * @param p_person_id Identifies the person who created the message.
40 * @param p_contact_id Identifies the external learner who created the message.
41 * @param p_target_person_id Identifies the target person to whom the message is posted.
42 * If not null, indicates that the message is a private message; else it is public to all.
43 * @param p_target_contact_id Identifies the target external learner to whom the message
44 * is posted. If not null, indicates that the message is a private message; else it is public to all.
45 * @param p_message_text The text of the message being posted.
46 * @param p_chat_message_id The unique identifier for the chat message record.
47 * @param p_object_version_number If p_validate is false, then set to the version number of the
48 * created chat message. If p_validate is true, then the value will be null.
49 * @rep:displayname Create Chat Message
50 * @rep:category BUSINESS_ENTITY OTA_CHAT
51 * @rep:lifecycle active
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
55 */
56 --
57 -- {End Of Comments}
58 --
59 procedure create_chat_message (
60 p_validate in boolean default false
61 ,p_effective_date in date
62 ,p_chat_id in number
63 ,p_person_id in number
64 ,p_contact_id in number
65 ,p_target_person_id in number
66 ,p_target_contact_id in number
67 ,p_message_text in varchar2
68 ,p_business_group_id in number
69 ,p_chat_message_id out nocopy number
70 ,p_object_version_number out nocopy number
71 );
72
73 --
74 -- ----------------------------------------------------------------------------
75 -- |---------------------------< update_chat_message >------------------------|
76 -- ----------------------------------------------------------------------------
77 --
78 -- {Start Of Comments}
79 /*#
80 * This API updates the chat message.
81 *
82 *
83 * <p><b>Licensing</b><br>
84 * This API is licensed for use with Learning Management.
85 *
86 * <p><b>Prerequisites</b><br>
87 * The chat message record with the given object version number should exist.
88 *
89 * <p><b>Post Success</b><br>
90 * The chat message is updated successfully.
91 *
92 * <p><b>Post Failure</b><br>
93 * The API does not update the chat message record, and raises an error.
94 *
95 * @param p_validate If true, then validation alone will be performed and the
96 * database will remain unchanged. If false and all validation checks pass,
97 * then the database will be modified.
98 * @param p_effective_date Reference date for validating that lookup values are applicable
99 * during the start to end active date range. This date does not determine when the changes take effect.
100 * @param p_chat_id Identifies the chat for which the message is posted.
101 * @param p_person_id Identifies the person who created the message.
102 * @param p_contact_id Identifies the external learner who created the message.
103 * @param p_target_person_id Identifies the target person to whom the message is posted. If not
104 * Null, indicates that the message is a private message; else it is public to all.
105 * @param p_target_contact_id Identifies the target external learner to whom the message is posted.
106 * If not null, indicates that the message is a private message; else it is public to all.
107 * @param p_message_text The text of the message being posted.
108 * @param p_business_group_id The unique identifier of the business group that owns this chat message.
109 * @param p_chat_message_id The unique identifier for the chat message record.
110 * @param p_object_version_number Pass in the current version number of the chat message to be updated.
111 * When the API completes if p_validate is false, will be set to the new version number of the updated
112 * chat message. If p_validate is true will be set to the same value which was passed in.
113 * @rep:displayname Update Chat Message
114 * @rep:category BUSINESS_ENTITY OTA_CHAT
115 * @rep:lifecycle active
116 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
117 * @rep:scope public
118 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
119 */
120 --
121 -- {End Of Comments}
122 --
123 procedure update_chat_message (
124 p_validate in boolean default false
125 ,p_effective_date in date
126 ,p_chat_id in number
127 ,p_person_id in number default hr_api.g_number
128 ,p_contact_id in number default hr_api.g_number
129 ,p_target_person_id in number default hr_api.g_number
130 ,p_target_contact_id in number default hr_api.g_number
131 ,p_message_text in varchar2 default hr_api.g_varchar2
132 ,p_business_group_id in number
133 ,p_chat_message_id in number
134 ,p_object_version_number in out nocopy number
135 );
136 --
137 -- ----------------------------------------------------------------------------
138 -- |---------------------------< delete_chat_message >------------------------|
139 -- ----------------------------------------------------------------------------
140 --
141 -- {Start Of Comments}
142 /*#
143 * This API deletes the chat message.
144 *
145 *
146 * <p><b>Licensing</b><br>
147 * This API is licensed for use with Learning Management.
148 *
149 * <p><b>Prerequisites</b><br>
150 * The chat message record with the given object version number should exist.
151 *
152 * <p><b>Post Success</b><br>
153 * The chat message is deleted successfully.
154 *
155 * <p><b>Post Failure</b><br>
156 * The API does not delete the chat message record, and raises an error.
157 *
158 * @param p_validate If true, then validation alone will be performed and the
159 * database will remain unchanged. If false and all validation checks pass,
160 * then the database will be modified.
161 * @param p_chat_message_id The unique identifier for the chat message record.
162 * @param p_object_version_number Current version number of the chat message to be deleted.
163 * @rep:displayname Delete Chat Message
164 * @rep:category BUSINESS_ENTITY OTA_CHAT
165 * @rep:lifecycle active
166 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
167 * @rep:scope public
168 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
169 */
170 --
171 -- {End Of Comments}
172 --
173
174 procedure delete_chat_message
175 (p_validate in boolean default false
176 ,p_chat_message_id in number
177 ,p_object_version_number in number
178 );
179 end ota_chat_message_api;
[Home] [Help]