1 Package HR_KI_USER_INTERFACES_API as
2 /* $Header: hritfapi.pkh 120.1 2005/10/02 02:03:16 aroussel $ */
3 /*#
4 * This package contains APIs that maintain definition for the HR Knowledge
5 * Integration User Interfaces.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration User Interface
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |--------------------------< create_user_interface >-----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a user interface for knowledge integration mappings.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with all products in the HRMS Product Family.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A valid type, form name or page region code and region code must exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The knowledge integration user interface definition will be successfully
28 * inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The knowledge integration user interface definition will not be created and
32 * an error will be raised.
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Reference date for validating lookup values are
37 * applicable during the start to end active date range. This date does not
38 * determine when the changes take effect.
39 * @param p_type Type of user interface. Valid values are PUI, SS and P. PUI =
40 * Forms, SS=Self Service, P=Portal
41 * @param p_form_name Form name if the type is PUI.
42 * @param p_page_region_code Page region code of the self service page if the
43 * type is SS.
44 * @param p_region_code Region code of the self service page if the type is SS.
45 * @param p_user_interface_id If p_validate is false, then this uniquely
46 * identifies the user interface been created. If p_validate is true, then set
47 * to null.
48 * @param p_object_version_number If p_validate is false, then set to the
49 * version number of the user interface definition record. If p_validate is
50 * true, then the value will be null.
51 * @rep:displayname Create User Interface
52 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
53 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
54 * @rep:scope public
55 * @rep:lifecycle active
56 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
57 */
58 --
59 -- {End Of Comments}
60 --
61 procedure create_user_interface
62 (
63 p_validate in boolean default false
64 ,p_effective_date in date
65 ,p_type in varchar2
66 ,p_form_name in varchar2 default null
67 ,p_page_region_code in varchar2 default null
68 ,p_region_code in varchar2 default null
69 ,p_user_interface_id out nocopy number
70 ,p_object_version_number out nocopy number
71 );
72 --
73 -- ----------------------------------------------------------------------------
74 -- |--------------------------< update_user_interface >-----------------------|
75 -- ----------------------------------------------------------------------------
76 --
77 -- {Start Of Comments}
78 /*#
79 * This API updates a user interface for knowledge integration mappings.
80 *
81 *
82 * <p><b>Licensing</b><br>
83 * This API is licensed for use with all products in the HRMS Product Family.
84 *
85 * <p><b>Prerequisites</b><br>
86 * A valid user interface id should be entered.
87 *
88 * <p><b>Post Success</b><br>
89 * The knowledge integration user interface definition will be successfully
90 * updated into the database.
91 *
92 * <p><b>Post Failure</b><br>
93 * The knowledge integration user interface definition will not be updated and
94 * an error will be raised.
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 lookup values are
99 * applicable during the start to end active date range. This date does not
100 * determine when the changes take effect.
101 * @param p_user_interface_id Uniquely identifies the user interface definition
102 * record.
103 * @param p_type Type of user interface. Valid values are PUI, SS and P. PUI =
104 * Forms, SS=Self Service, P=Portal
105 * @param p_form_name Form name if the type is PUI.
106 * @param p_page_region_code Page region code of the self service page if the
107 * type is SS.
108 * @param p_region_code Region code of the self service page if the type is SS.
109 * @param p_object_version_number Pass in the current version number of the
110 * user interface definition to be updated. When the API completes if
111 * p_validate is false, will be set to the new version number of the updated
112 * user interface definition. If p_validate is true will be set to the same
113 * value which was passed in.
114 * @rep:displayname Update User Interface
115 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
116 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
117 * @rep:scope public
118 * @rep:lifecycle active
119 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
120 */
121 --
122 -- {End Of Comments}
123 --
124 procedure update_user_interface
125 (
126 p_validate in boolean default false
127 ,p_effective_date in date
128 ,p_user_interface_id in number
129 ,p_type in varchar2 default hr_api.g_varchar2
130 ,p_form_name in varchar2 default hr_api.g_varchar2
131 ,p_page_region_code in varchar2 default hr_api.g_varchar2
132 ,p_region_code in varchar2 default hr_api.g_varchar2
133 ,p_object_version_number in out nocopy number
134 );
135 --
136 -- ----------------------------------------------------------------------------
137 -- |--------------------------< delete_user_interface >-----------------------|
138 -- ----------------------------------------------------------------------------
139 --
140 -- {Start Of Comments}
141 /*#
142 * This API deletes a user interface for knowledge integration mappings.
143 *
144 *
145 * <p><b>Licensing</b><br>
146 * This API is licensed for use with all products in the HRMS Product Family.
147 *
148 * <p><b>Prerequisites</b><br>
149 * User interface id and object version number should be entered.
150 *
151 * <p><b>Post Success</b><br>
152 * The knowledge integration user interface definition will be successfully
153 * deleted from the database.
154 *
155 * <p><b>Post Failure</b><br>
156 * The knowledge integration user interface definition will not be deleted and
157 * an error will be raised.
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_user_interface_id Uniquely identifies the user interface definition
162 * record.
163 * @param p_object_version_number Current version number of the user interface
164 * to be deleted.
165 * @rep:displayname Delete User Interface
166 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
167 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
168 * @rep:scope public
169 * @rep:lifecycle active
170 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
171 */
172 --
173 -- {End Of Comments}
174 --
175 procedure delete_user_interface
176 (
177 P_VALIDATE in boolean default false
178 ,P_USER_INTERFACE_ID in number
179 ,P_OBJECT_VERSION_NUMBER in number
180 );
181 --
182 end HR_KI_USER_INTERFACES_API;
[Home] [Help]