1 Package pqh_TRAN_CATEGORY_api AUTHID CURRENT_USER as
2 /* $Header: pqtctapi.pkh 120.1 2005/10/02 02:28:26 aroussel $ */
3 /*#
4 * This package contains transaction category API.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Transaction Category
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_TRAN_CATEGORY >------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 --
15 -- Description:
16 --
17 -- Prerequisites:
18 --
19 --
20 -- In Parameters:
21 -- Name Reqd Type Description
22 -- p_validate Yes boolean Commit or Rollback.
23 -- p_custom_wf_process_name No varchar2
24 -- p_custom_workflow_name No varchar2
25 -- p_form_name Yes varchar2
26 -- p_freeze_status_cd No varchar2
27 -- p_future_action_cd Yes varchar2
28 -- p_member_cd Yes varchar2
29 -- p_name Yes varchar2
30 -- p_short_name Yes varchar2
31 -- p_post_style_cd Yes varchar2
32 -- p_post_txn_function Yes varchar2
33 -- p_route_validated_txn_flag Yes varchar2
34 -- p_workflow_enable_flag Yes varchar2
35 -- p_enable_flag Yes varchar2
36 -- p_timeout_days No number
37 -- p_consolidated_table_route_id Yes number
38 -- p_master_table_route_id Yes number
39 -- p_effective_date Yes date Session Date.
40 -- p_language_code Yes language For translation
41 --
42 -- Post Success:
43 --
44 -- Out Parameters:
45 -- Name Type Description
46 -- p_transaction_category_id Yes number PK of record
47 -- p_object_version_number Yes number OVN of record
48 --
49 -- Post Failure:
50 --
51 -- Access Status:
52 -- Public.
53 --
54 -- {End Of Comments}
55 --
56 procedure create_TRAN_CATEGORY
57 (
58 p_validate in boolean default false
59 ,p_transaction_category_id out nocopy number
60 ,p_custom_wf_process_name in varchar2 default null
61 ,p_custom_workflow_name in varchar2 default null
62 ,p_form_name in varchar2
63 ,p_freeze_status_cd in varchar2 default null
64 ,p_future_action_cd in varchar2
65 ,p_member_cd in varchar2
66 ,p_name in varchar2
67 ,p_short_name in varchar2
68 ,p_post_style_cd in varchar2
69 ,p_post_txn_function in varchar2
70 ,p_route_validated_txn_flag in varchar2
71 ,p_prevent_approver_skip in varchar2 default null
72 ,p_workflow_enable_flag in varchar2 default null
73 ,p_enable_flag in varchar2 default 'Y'
74 ,p_timeout_days in number default null
75 ,p_object_version_number out nocopy number
76 ,p_consolidated_table_route_id in number
77 ,p_business_group_id in number default null
78 ,p_setup_type_cd in varchar2 default null
79 ,p_master_table_route_id in number default null
80 ,p_effective_date in date
81 ,p_language_code in varchar2 default hr_api.userenv_lang
82 );
83 --
84 -- ----------------------------------------------------------------------------
85 -- |---------------------------< update_tran_category >-----------------------|
86 -- ----------------------------------------------------------------------------
87 --
88 -- {Start Of Comments}
89 /*#
90 * This API updates transaction type details.
91 *
92 * The transaction type setup defines how the related transactions will be
93 * routed. The routing style of a transaction type cannot be changed if there
94 * are pending transactions routed to that transaction type.
95 *
96 * <p><b>Licensing</b><br>
97 * This API is licensed for use with Human Resources.
98 *
99 * <p><b>Prerequisites</b><br>
100 * If the transaction type is for a specific business group, the business group
101 * must already exist. The routing style of the transaction category can be
102 * updated only if there are no pending transactions for the transaction type.
103 *
104 * <p><b>Post Success</b><br>
105 * The transaction type details are successfully updated.
106 *
107 * <p><b>Post Failure</b><br>
108 * The transaction type details will not be updated and an error is raised.
109 * @param p_validate If true, then validation alone will be performed and the
110 * database will remain unchanged. If false and all validation checks pass,
111 * then the database will be modified.
112 * @param p_transaction_category_id Identifies the transaction type record to
113 * be modified.
114 * @param p_custom_wf_process_name {@rep:casecolumn
115 * PQH_TRANSACTION_CATEGORIES.CUSTOM_WF_PROCESS_NAME}
116 * @param p_custom_workflow_name {@rep:casecolumn
117 * PQH_TRANSACTION_CATEGORIES.CUSTOM_WORKFLOW_NAME}
118 * @param p_form_name {@rep:casecolumn PQH_TRANSACTION_CATEGORIES.FORM_NAME}
119 * @param p_freeze_status_cd Transaction type setup status. Valid values are
120 * defined by 'PQH_CATEGORY_FREEZE_STATUS' lookup type.
121 * @param p_future_action_cd Future Action values. Valid values are defined by
122 * 'PQH_FUTURE_ACTION' lookup type.
123 * @param p_member_cd Transaction routing style. Valid values are defined by
124 * 'PQH_MEMBER_CD' lookup type.
125 * @param p_name Transaction type name.
126 * @param p_short_name {@rep:casecolumn PQH_TRANSACTION_CATEGORIES.SHORT_NAME}
127 * @param p_post_style_cd Transaction posting style. Valid values are defined
128 * by 'PQH_POST_STYLE' lookup type.
129 * @param p_post_txn_function {@rep:casecolumn
130 * PQH_TRANSACTION_CATEGORIES.POST_TXN_FUNCTION}
131 * @param p_route_validated_txn_flag Used to check if routed transaction must
132 * be validated. Valid values are defined by 'YES_NO' lookup type.
133 * @param p_prevent_approver_skip Identifies if bypass of approvers is allowed.
134 * Valid values are defined by 'YES_NO' lookup_type. Default Value is 'N'.
135 * @param p_workflow_enable_flag Used to enable workflow for transaction
136 * routing. Valid values are defined by 'YES_NO' lookup type.
137 * @param p_enable_flag Used to enable or disable transaction type. Valid
138 * values are defined by 'YES_NO' lookup type.
139 * @param p_timeout_days Number of days after which the transaction would be
140 * returned to the initiator if no response has been made.
141 * @param p_object_version_number Pass in the current version number of the
142 * transaction type to be updated. When the API completes if p_validate is
143 * false, will be set to the new version number of the updated transaction
144 * type. If p_validate is true will be set to the same value which was passed
145 * in.
146 * @param p_consolidated_table_route_id {@rep:casecolumn
147 * PQH_TRANSACTION_CATEGORIES.CONSOLIDATED_TABLE_ROUTE_ID}
148 * @param p_business_group_id {@rep:casecolumn
149 * PQH_TRANSACTION_CATEGORIES.BUSINESS_GROUP_ID}
150 * @param p_setup_type_cd The setup level of the transaction type. Valid values
151 * are defined by 'PQH_TXN_CAT_SETUP_TYPE' lookup type.
152 * @param p_master_table_route_id {@rep:casecolumn
153 * PQH_TRANSACTION_CATEGORIES.MASTER_TABLE_ROUTE_ID}
154 * @param p_effective_date Reference date for validating lookup values are
155 * applicable during the start to end active date range. This date does not
156 * determine when the changes take effect.
157 * @param p_language_code Specifies to which language the translation values
158 * apply. You can set to the base or any installed language. The default value
159 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
160 * value.
161 * @rep:displayname Update Transaction Category
162 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
163 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
164 * @rep:scope public
165 * @rep:lifecycle active
166 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
167 */
168 --
169 -- {End Of Comments}
170 --
171 procedure update_TRAN_CATEGORY
172 (
173 p_validate in boolean default false
174 ,p_transaction_category_id in number
175 ,p_custom_wf_process_name in varchar2 default hr_api.g_varchar2
176 ,p_custom_workflow_name in varchar2 default hr_api.g_varchar2
177 ,p_form_name in varchar2 default hr_api.g_varchar2
178 ,p_freeze_status_cd in varchar2 default hr_api.g_varchar2
179 ,p_future_action_cd in varchar2 default hr_api.g_varchar2
180 ,p_member_cd in varchar2 default hr_api.g_varchar2
181 ,p_name in varchar2 default hr_api.g_varchar2
182 ,p_short_name in varchar2 default hr_api.g_varchar2
183 ,p_post_style_cd in varchar2 default hr_api.g_varchar2
184 ,p_post_txn_function in varchar2 default hr_api.g_varchar2
185 ,p_route_validated_txn_flag in varchar2 default hr_api.g_varchar2
186 ,p_prevent_approver_skip in varchar2 default hr_api.g_varchar2
187 ,p_workflow_enable_flag in varchar2 default hr_api.g_varchar2
188 ,p_enable_flag in varchar2 default hr_api.g_varchar2
189 ,p_timeout_days in number default hr_api.g_number
190 ,p_object_version_number in out nocopy number
191 ,p_consolidated_table_route_id in number default hr_api.g_number
192 ,p_business_group_id in number default hr_api.g_number
193 ,p_setup_type_cd in varchar2 default hr_api.g_varchar2
194 ,p_master_table_route_id in number default hr_api.g_number
195 ,p_effective_date in date
196 ,p_language_code in varchar2 default hr_api.userenv_lang
197 );
198 --
199 -- ----------------------------------------------------------------------------
200 -- |------------------------< delete_TRAN_CATEGORY >------------------------|
201 -- ----------------------------------------------------------------------------
202 -- {Start Of Comments}
203 --
204 -- Description:
205 --
206 -- Prerequisites:
207 --
208 --
209 -- In Parameters:
210 -- Name Reqd Type Description
211 -- p_validate Yes boolean Commit or Rollback.
212 -- p_transaction_category_id Yes number PK of record
213 -- p_effective_date Yes date Session Date.
214 --
215 -- Post Success:
216 --
217 -- Name Type Description
218 -- p_object_version_number Yes number OVN of record
219 --
220 -- Post Failure:
221 --
222 -- Access Status:
223 -- Public.
224 --
225 -- {End Of Comments}
226 --
227 procedure delete_TRAN_CATEGORY
228 (
229 p_validate in boolean default false
230 ,p_transaction_category_id in number
231 ,p_object_version_number in number
232 ,p_effective_date in date
233 );
234 --
235 end pqh_TRAN_CATEGORY_api;
[Home] [Help]