1 Package hr_api_hook_call_api as
2 /* $Header: peahcapi.pkh 120.3 2006/09/13 12:34:17 sgelvi noship $ */
3 /*#
4 * This package contains APIs for maintaining User Hook Calls.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname API Hook Call
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_api_hook_call >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a User Hook Call.
17 *
18 * Creates user hook call information in the HR_API_HOOK_CALLS table. The user
19 * hook call specifies which extra logic, package procedures or formula should
20 * be called from the API hook points. Each row should be a child of a parent
21 * API Hook which already exists on the HR_API_HOOKS table.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with all products in the HRMS Product Family.
25 *
26 * <p><b>Prerequisites</b><br>
27 * An API Hook must have been created so that the Hook Call can be attached to
28 * it.
29 *
30 * <p><b>Post Success</b><br>
31 * The API successfully creates the hook call.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the hook call and raises an error.
35 * @param p_validate If true, then validation alone will be performed and the
36 * database will remain unchanged. If false and all validation checks pass,
37 * then the database will be modified.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_api_hook_id Acts as the foreign key to the HR_API_HOOKS table.
42 * @param p_api_hook_call_type The type of the hook call. Can only be set to
43 * 'PP' for the first version.
44 * @param p_sequence When more than one row exists for the same API_HOOK_ID,
45 * the sequence will affect the order of the hook calls (low numbers will be
46 * processed first).
47 * @param p_enabled_flag Determines whether the hook call is enabled or not.
48 * Valid values are defined by 'YES_NO' lookup type.
49 * @param p_call_package Name of the database package that the hook package
50 * should call to create.
51 * @param p_call_procedure Name of the procedure within the call package that
52 * the hook package should call.
53 * @param p_api_hook_call_id If p_validate is false, then this uniquely
54 * identifies the api hook call created. If p_validate is true, then set to
55 * null.
56 * @param p_object_version_number If p_validate is false, then set to the
57 * version number of the created hook call. If p_validate is true, then the
58 * value will be null.
59 * @rep:displayname Create API Hook Call
60 * @rep:category BUSINESS_ENTITY HR_USER_HOOK
61 * @rep:scope public
62 * @rep:lifecycle active
63 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
64 */
65 --
66 -- {End Of Comments}
67 --
68 procedure create_api_hook_call
69 (p_validate in boolean default false,
70 p_effective_date in date,
71 p_api_hook_id in number,
72 p_api_hook_call_type in varchar2,
73 p_sequence in number,
74 p_enabled_flag in varchar2,
75 p_call_package in varchar2 default null,
76 p_call_procedure in varchar2 default null,
77 p_api_hook_call_id out nocopy number,
78 p_object_version_number out nocopy number);
79 --
80 -- ----------------------------------------------------------------------------
81 -- |---------------------------< delete_api_hook_call >-----------------------|
82 -- ----------------------------------------------------------------------------
83 --
84 -- {Start Of Comments}
85 /*#
86 * This API deletes a User Hook Call.
87 *
88 * Only hook calls which have been created using the create_api_hook_call, can
89 * be deleted. Any hook calls which are pre-seeded by legislation groups cannot
90 * be deleted using this API. These hook calls have a set legislation code.
91 *
92 * <p><b>Licensing</b><br>
93 * This API is licensed for use with all products in the HRMS Product Family.
94 *
95 * <p><b>Prerequisites</b><br>
96 * A hook call id with a legislation code set to null. The object version
97 * number of the hook call id.
98 *
99 * <p><b>Post Success</b><br>
100 * The API hook call will successfully be deleted.
101 *
102 * <p><b>Post Failure</b><br>
103 * The API does not delete the hook call and raises an error.
104 * @param p_validate If true, then validation alone will be performed and the
105 * database will remain unchanged. If false and all validation checks pass,
106 * then the database will be modified.
107 * @param p_api_hook_call_id Unique identifier for the hook call to be deleted.
108 * @param p_object_version_number Current version number of the API Hook call
109 * to be deleted.
110 * @rep:displayname Delete API Hook Call
111 * @rep:category BUSINESS_ENTITY HR_USER_HOOK
112 * @rep:scope public
113 * @rep:lifecycle active
114 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
115 */
116 --
117 -- {End Of Comments}
118 --
119 procedure delete_api_hook_call
120 (p_validate in boolean default false,
121 p_api_hook_call_id in number,
122 p_object_version_number in number
123 );
124 --
125 -- ----------------------------------------------------------------------------
126 -- |---------------------------< update_api_hook_call >-----------------------|
127 -- ----------------------------------------------------------------------------
128 --
129 -- {Start Of Comments}
130 /*#
131 * This API updates a User Hook Call.
132 *
133 * A hook call cannot be updated if the LEGISLATION_CODE is not null. Only hook
134 * calls with null legislation codes can be updated with this API.
135 *
136 * <p><b>Licensing</b><br>
137 * This API is licensed for use with all products in the HRMS Product Family.
138 *
139 * <p><b>Prerequisites</b><br>
140 * The API hook call id with a null legislation code.
141 *
142 * <p><b>Post Success</b><br>
143 * The hook call will be successfully updated in the database.
144 *
145 * <p><b>Post Failure</b><br>
146 * The hook call will not be updated and an error will be raised.
147 * @param p_validate If true, then validation alone will be performed and the
148 * database will remain unchanged. If false and all validation checks pass,
149 * then the database will be modified.
150 * @param p_effective_date Reference date for validating lookup values are
151 * applicable during the start to end active date range. This date does not
152 * determine when the changes take effect.
153 * @param p_api_hook_call_id Unique identifier for the hook call to be updated.
154 * @param p_sequence When more than one row exists for the same API_HOOK_ID,
155 * the sequence will affect the order of the hook calls (low numbers will be
156 * processed first).
157 * @param p_enabled_flag Determines whether the hook call is enabled or not.
158 * Valid values are defined by 'YES_NO' lookup type.
159 * @param p_call_package Name of the database package that the hook package
160 * should call to update.
161 * @param p_call_procedure Name of the procedure within the call package that
162 * the API hook should call.
163 * @param p_object_version_number Pass in the current version number of the HR
164 * API Hook Call to be updated. When the API completes if p_validate is false,
165 * will be set to the new version number of the updated HR API Hook Call. If
166 * p_validate is true will be set to the same value which was passed in.
167 * @rep:displayname Update API Hook Call
168 * @rep:category BUSINESS_ENTITY HR_USER_HOOK
169 * @rep:scope public
170 * @rep:lifecycle active
171 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
172 */
173 --
174 -- {End Of Comments}
175 --
176 procedure update_api_hook_call
177 (p_validate in boolean default false,
178 p_effective_date in date,
179 p_api_hook_call_id in number,
180 p_sequence in number default hr_api.g_number,
181 p_enabled_flag in varchar2 default hr_api.g_varchar2,
182 p_call_package in varchar2 default hr_api.g_varchar2,
183 p_call_procedure in varchar2 default hr_api.g_varchar2,
184 p_object_version_number in out nocopy number) ;
185
186 end hr_api_hook_call_api;
[Home] [Help]