1 Package HR_KI_UI_CONTEXTS_API as
2 /* $Header: hrucxapi.pkh 120.1 2006/10/12 14:31:44 avarri noship $ */
3 /*#
4 * This package contains APIs that maintain definition for the HR Knowledge
5 * Integration UI Contexts.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration UI Context
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_ui_context >-------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This api creates a UI Context.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with all products in the HRMS Product Family.
21 *
22 * <p><b>Prerequisites</b><br>
23 * A valid user_interface_id, label, location should be entered
24 *
25 * <p><b>Post Success</b><br>
26 * UI context for the given user interface will be successfully
27 * inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * UI Context will not be created and an error will be raised.
31 *
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_label This specifies the label of UI.
36 * @param p_location This specifies the location of field in UI.
37 * It should be in the format of pageLayoutName.RegionName.
38 * For example, createEmployeePageLayout.EmployeeDetailsRN.
39 * @param p_user_interface_id This specifies the unique identifier of the
40 * user interface.
41 * @param p_ui_context_id If p_validate is false, then this uniquely
42 * identifies the created ui context. If p_validate is true, then set
43 * to null.
44 * @param p_object_version_number If p_validate is false, then it is set to
45 * the version number of the created ui context. If p_validate is true, then
46 * it is set to null.
47 * @rep:displayname Create UI Context
48 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
49 * @rep:lifecycle active
50 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
51 * @rep:scope public
52 */
53 --
54 -- {End Of Comments}
55 --
56 procedure CREATE_UI_CONTEXT
57 ( p_validate in boolean default false
58 ,p_label in varchar2
59 ,p_location in varchar2
60 ,p_user_interface_id in number
61 ,p_ui_context_id out nocopy number
62 ,p_object_version_number out nocopy number
63 );
64 --
65 -- ----------------------------------------------------------------------------
66 -- |----------------------------< delete_ui_context >-------------------------|
67 -- ----------------------------------------------------------------------------
68 --
69 -- {Start Of Comments}
70 /*#
71 * This api deletes a UI Context.
72 *
73 * <p><b>Licensing</b><br>
74 * This API is licensed for use with all products in the HRMS Product Family.
75 *
76 * <p><b>Prerequisites</b><br>
77 * ui_context_id and object_version_number should be valid.
78 *
79 * <p><b>Post Success</b><br>
80 * The API deletes the UI Context successfully.
81 *
82 * <p><b>Post Failure</b><br>
83 * UI Context will not be deleted and error will be raised.
84 *
85 * @param p_validate If true, then validation alone will be performed and the
86 * database will remain unchanged. If false and all validation checks pass,
87 * then the database will be modified.
88 * @param p_ui_context_id This uniquely identifies the ui context to be deleted.
89 * @param p_object_version_number Current version number of the ui context
90 * to be deleted.
91 * @rep:displayname Delete UI Context
92 * @rep:category BUSINESS_ENTITY HR_KI_SYSTEM
93 * @rep:lifecycle active
94 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
95 * @rep:scope public
96 */
97 --
98 -- {End Of Comments}
99 --
100 procedure DELETE_UI_CONTEXT
101 (
102 p_validate in boolean default false
103 ,p_ui_context_id in number
104 ,p_object_version_number in number
105 );
106 --
107 end HR_KI_UI_CONTEXTS_API;
[Home] [Help]