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