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