1 Package hxc_time_recipient_api as
2 /* $Header: hxchtrapi.pkh 120.1 2005/10/02 02:06:55 aroussel $ */
3 /*#
4 * This package contains Time Recipient APIs.
5 * @rep:scope public
6 * @rep:product hxt
7 * @rep:displayname Time Recipient
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_time_recipient >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a Time Recipient within the Time Store.
17 *
18 * This API creates the details of the Recipient Applications that are
19 * registered to use the Time Store.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Time and Labor.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The Application for which the Time Recipient is created must exist.
26 *
27 * <p><b>Post Success</b><br>
28 * The Time Recipient will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The Time Recipient will not be inserted and an application error will be
32 * 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_time_recipient_id Primary Key for entity.
37 * @param p_application_id Foreign key to FND_APPLICATION.
38 * @param p_object_version_number If P_VALIDATE is false, then the value is set
39 * to the version number of the created Time Recipient. If P_VALIDATE is true,
40 * then the value will be null.
41 * @param p_name Name for the Time Recipient.
42 * @param p_appl_retrieval_function Package procedure to obtain application
43 * mapping.
44 * @param p_appl_update_process Package procedure for application specific
45 * updates to time data.
46 * @param p_appl_validation_process Package procedure to application specific
47 * validation.
48 * @param p_appl_period_function Package procedure to support application
49 * specific time periods.
50 * @param p_appl_dyn_template_process Package procedure used to implement a
51 * dynamic template selected on the timecard page.
52 * @param p_extension_function1 Package procedure to support client hooks.
53 * @param p_extension_function2 Package procedure to support client hooks.
54 * @rep:displayname Create Time Recipient
55 * @rep:category BUSINESS_ENTITY HXC_TIME_RECIPIENT
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_time_recipient
65 (p_validate in boolean default false
66 ,p_time_recipient_id in out nocopy hxc_time_recipients.time_recipient_id%TYPE
67 ,p_application_id in out nocopy hxc_time_recipients.application_id%TYPE
68 ,p_object_version_number in out nocopy hxc_time_recipients.object_version_number%TYPE
69 ,p_name in varchar2
70 ,p_appl_retrieval_function in varchar2 default NULL
71 ,p_appl_update_process in varchar2 default NULL
72 ,p_appl_validation_process in varchar2 default NULL
73 ,p_appl_period_function in varchar2 default NULL
74 ,p_appl_dyn_template_process in varchar2 default NULL
75 ,p_extension_function1 in varchar2 default NULL
76 ,p_extension_function2 in varchar2 default NULL
77 );
78 --
79 -- ----------------------------------------------------------------------------
80 -- |--------------------------< update_time_recipient >-----------------------|
81 -- ----------------------------------------------------------------------------
82 --
83 -- {Start Of Comments}
84 /*#
85 * This API updates an existing Time Recipient with a given name and
86 * application.
87 *
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with Time and Labor.
91 *
92 * <p><b>Prerequisites</b><br>
93 * The Time Recipient must exist.
94 *
95 * <p><b>Post Success</b><br>
96 * The Time Recipient will be updated successfully in the database.
97 *
98 * <p><b>Post Failure</b><br>
99 * The Time Recipient will not be updated and an application error will be
100 * raised.
101 * @param p_validate If true, then validation alone will be performed and the
102 * database will remain unchanged. If false and all validation checks pass,
103 * then the database will be modified.
104 * @param p_time_recipient_id Primary Key for entity.
105 * @param p_application_id Foreign key to FND_APPLICATION.
106 * @param p_object_version_number Pass in the current version number of the
107 * Time Recipient to be updated. If P_VALIDATE is false, then the value will be
108 * set to the new version number of the updated Time Recipient. If P_VALIDATE
109 * is true, then the value will be set to the value passed.
110 * @param p_name Name for the Time Recipient.
111 * @param p_appl_retrieval_function Package procedure to obtain application
112 * mapping.
113 * @param p_appl_update_process Package procedure for application specific
114 * updates to time data.
115 * @param p_appl_validation_process Package procedure to application specific
116 * validation.
117 * @param p_appl_period_function Package procedure to support application
118 * specific time periods.
119 * @param p_appl_dyn_template_process Package procedure used to implement a
120 * dynamic template selected on the timecard page.
121 * @param p_extension_function1 Package procedure to support client hooks.
122 * @param p_extension_function2 Package procedure to support client hooks.
123 * @rep:displayname Update Time Recipient
124 * @rep:category BUSINESS_ENTITY HXC_TIME_RECIPIENT
125 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
126 * @rep:scope public
127 * @rep:lifecycle active
128 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
129 */
130 --
131 -- {End Of Comments}
132 --
133 procedure update_time_recipient
134 (p_validate in boolean default false
135 ,p_time_recipient_id in hxc_time_recipients.time_recipient_id%TYPE
136 ,p_application_id in hxc_time_recipients.application_id%TYPE
137 ,p_object_version_number in out nocopy hxc_time_recipients.object_version_number%TYPE
138 ,p_name in hxc_time_recipients.name%TYPE
139 ,p_appl_retrieval_function in varchar2 default NULL
140 ,p_appl_update_process in varchar2 default NULL
141 ,p_appl_validation_process in varchar2 default NULL
142 ,p_appl_period_function in varchar2 default NULL
143 ,p_appl_dyn_template_process in varchar2 default NULL
144 ,p_extension_function1 in varchar2 default NULL
145 ,p_extension_function2 in varchar2 default NULL
146 );
147 --
148 -- ----------------------------------------------------------------------------
149 -- |--------------------------< delete_time_recipient >-----------------------|
150 -- ----------------------------------------------------------------------------
151 --
152 -- {Start Of Comments}
153 /*#
154 * This API deletes an existing Time Recipient.
155 *
156 *
157 * <p><b>Licensing</b><br>
158 * This API is licensed for use with Time and Labor.
159 *
160 * <p><b>Prerequisites</b><br>
161 * The Time Recipient must exist.
162 *
163 * <p><b>Post Success</b><br>
164 * The Time Recipient will be successfully deleted from the database.
165 *
166 * <p><b>Post Failure</b><br>
167 * The Time Recipient will not be deleted and an application error will be
168 * raised.
169 * @param p_validate If true, then validation alone will be performed and the
170 * database will remain unchanged. If false and all validation checks pass,
171 * then the database will be modified.
172 * @param p_time_recipient_id Primary Key for entity.
173 * @param p_object_version_number Current version number to be deleted.
174 * @rep:displayname Delete Time Recipient
175 * @rep:category BUSINESS_ENTITY HXC_TIME_RECIPIENT
176 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
177 * @rep:scope public
178 * @rep:lifecycle active
179 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
180 */
181 --
182 -- {End Of Comments}
183 --
184 procedure delete_time_recipient
185 (p_validate in boolean default false
186 ,p_time_recipient_id in hxc_time_recipients.time_recipient_id%TYPE
187 ,p_object_version_number in hxc_time_recipients.object_version_number%TYPE
188 );
189 --
190 --
191 END hxc_time_recipient_api;
[Home] [Help]