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