1 Package HR_KI_OPTIONS_API as
2 /* $Header: hroptapi.pkh 120.1 2005/10/02 02:04:45 aroussel $ */
3 /*#
4 * This package contains APIs to maintain the knowledge integration privilege
5 * options.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration Option
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |------------------------------< create_option >---------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a knowledge integration accessibility option.
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 Option Type Key, Display Type, Option Name and Source Language
25 * should be entered.
26 *
27 * <p><b>Post Success</b><br>
28 * The knowledge integration options definition will be successfully inserted
29 * into the database.
30 *
31 * <p><b>Post Failure</b><br>
32 * The knowledge integration options definition will not be created and an
33 * error will be raised.
34 * @param p_validate If true, then validation alone will be performed and the
35 * database will remain unchanged. If false and all validation checks pass,
36 * then the database will be modified.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does not
39 * determine when the changes take effect.
40 * @param p_option_type_id {@rep:casecolumn HR_KI_OPTION_TYPES.OPTION_TYPE_ID}
41 * @param p_option_level The level at which authentication can be set. Valid
42 * values are 100 (Site), 80 (Application), 60 (Responsibility) and 20 (User).
43 * @param p_option_level_id Identifies the level value for example user_id for
44 * a user, responsibility_id for a responsibility.
45 * @param p_value Value of the knowledge integration system option.
46 * @param p_encrypted Flag to indicate if the option value is encrypted or not.
47 * Valid values are Y or N.
48 * @param p_integration_id {@rep:casecolumn HR_KI_INTEGRATIONS.INTEGRATION_ID}
49 * @param p_option_id If p_validate is false, then this uniquely identifies the
50 * user option been created. If p_validate is true, then set to null.
51 * @param p_object_version_number If p_validate is false, then set to the
52 * version number of the options definition record. If p_validate is true, then
53 * the value will be null.
54 * @rep:displayname Create Knowledge Integration Option
55 * @rep:category BUSINESS_ENTITY HR_KI_MAP
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
57 * @rep:scope public
58 * @rep:lifecycle active
59 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
60 */
61 --
62 -- {End Of Comments}
63 --
64 procedure create_option
65 (
66 p_validate in boolean default false
67 ,p_effective_date in date
68 ,p_option_type_id in number
69 ,p_option_level in number
70 ,p_option_level_id in varchar2 default null
71 ,p_value in varchar2 default null
72 ,p_encrypted in varchar2 default 'N'
73 ,p_integration_id in number
74 ,p_option_id out nocopy number
75 ,p_object_version_number out nocopy number
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |------------------------------< update_option >---------------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates a knowledge integration accessibility option.
85 *
86 *
87 * <p><b>Licensing</b><br>
88 * This API is licensed for use with all products in the HRMS Product Family.
89 *
90 * <p><b>Prerequisites</b><br>
91 * A valid option id should be entered.
92 *
93 * <p><b>Post Success</b><br>
94 * The knowledge integration options definition will be successfully updated
95 * into the database.
96 *
97 * <p><b>Post Failure</b><br>
98 * The knowledge integration options definition will not be updated and an
99 * error will be raised.
100 * @param p_validate If true, then validation alone will be performed and the
101 * database will remain unchanged. If false and all validation checks pass,
102 * then the database will be modified.
103 * @param p_option_id Uniquely identifies the options record.
104 * @param p_value Value of the knowledge integration system option.
105 * @param p_encrypted Flag to indicate if the option value is encrypted or not.
106 * Valid values are Y or N.
107 * @param p_object_version_number Pass in the current version number of the
108 * options definition to be updated. When the API completes if p_validate is
109 * false, will be set to the new version number of the updated options
110 * definition. If p_validate is true will be set to the same value which was
111 * passed in.
112 * @rep:displayname Update Knowledge Integration Option
113 * @rep:category BUSINESS_ENTITY HR_KI_MAP
114 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
118 */
119 --
120 -- {End Of Comments}
121 --
122 procedure update_option
123 (
124 p_validate in boolean default false
125 ,p_option_id in number
126 ,p_value in varchar2 default hr_api.g_varchar2
127 ,p_encrypted in varchar2 default hr_api.g_varchar2
128 ,p_object_version_number in out nocopy number
129 );
130 --
131 -- ----------------------------------------------------------------------------
132 -- |------------------------------< delete_option >---------------------------|
133 -- ----------------------------------------------------------------------------
134 --
135 -- {Start Of Comments}
136 /*#
137 * This API deletes a knowledge integration accessibility option.
138 *
139 *
140 * <p><b>Licensing</b><br>
141 * This API is licensed for use with all products in the HRMS Product Family.
142 *
143 * <p><b>Prerequisites</b><br>
144 * Option id and object version number should be entered.
145 *
146 * <p><b>Post Success</b><br>
147 * The knowledge integration options definition will be successfully deleted
148 * from the database.
149 *
150 * <p><b>Post Failure</b><br>
151 * The knowledge integration options definition will not be deleted and an
152 * error will be raised.
153 * @param p_validate If true, then validation alone will be performed and the
154 * database will remain unchanged. If false and all validation checks pass,
155 * then the database will be modified.
156 * @param p_option_id Uniquely identifies the options record.
157 * @param p_object_version_number Current version number of the options
158 * definition to be deleted.
159 * @rep:displayname Delete Knowledge Integration Option
160 * @rep:category BUSINESS_ENTITY HR_KI_MAP
161 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
162 * @rep:scope public
163 * @rep:lifecycle active
164 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
165 */
166 --
167 -- {End Of Comments}
168 --
169 procedure delete_option
170 (
171 P_VALIDATE in boolean default false
172 ,P_OPTION_ID in number
173 ,P_OBJECT_VERSION_NUMBER in number
174 );
175 --
176 end HR_KI_OPTIONS_API;
[Home] [Help]