1 Package AME_TRANS_TYPE_API as
2 /* $Header: amacaapi.pkh 120.1 2006/04/21 09:11 avarri noship $ */
3 /*#
4 * This package contains the AME Transaction Type APIs.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Transaction Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_ame_transaction_type >--------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new transaction type.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is available for use with any licensed component of the
20 * e-business suite.
21 *
22 * <p><b>Prerequisites</b><br>
23 * No known prerequisites.
24 *
25 * <p><b>Post Success</b><br>
26 * Transaction type is created. Application_id, object_version_number,
27 * start_date and end_date are set for the new transaction type.
28 *
29 * <p><b>Post Failure</b><br>
30 * The transaction type is not created and an error is 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_language_code Specifies to which language the translation values
36 * apply. You can set to the base or any installed language. The default value
37 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
38 * value.
39 * @param p_application_name The name of the transaction type being created.
40 * Typically this property must identify the nature of the transaction.
41 * @param p_fnd_application_id The fnd_application ID of the transaction type
42 * being created. It should be present in the fnd_application table.
43 * @param p_transaction_type_id This is an user defined ID for the
44 * Transaction Type.
45 * @param p_application_id If p_validate is false, then this uniquely
46 * identifies the transaction type created. If p_validate is true,
47 * then it is set to null.
48 * @param p_object_version_number If p_validate is false, then it is set to
49 * version number of the created transaction type. If p_validate is true,
50 * then it is set to null.
51 * @param p_start_date If p_validate is false, then it is set to the
52 * effective start date for the created transaction type.
53 * If p_validate is true, then it is set to null.
54 * @param p_end_date It is the date upto which the transaction type is
55 * effective. If p_validate is false, then it is set to 31-Dec-4712.
56 * If p_validate is true, then it is set to null.
57 * @rep:displayname Create Transaction Type
58 * @rep:category BUSINESS_ENTITY AME_TRANSACTION_TYPE
59 * @rep:lifecycle active
60 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
61 * @rep:scope public
62 */
63 --
64 -- {End Of Comments}
65 --
66 procedure create_ame_transaction_type
67 (p_validate in boolean default false
68 ,p_language_code in varchar2 default hr_api.userenv_lang
69 ,p_application_name in varchar2
70 ,p_fnd_application_id in number
71 ,p_transaction_type_id in varchar2
72 ,p_application_id out nocopy number
73 ,p_object_version_number out nocopy number
74 ,p_start_date out nocopy date
75 ,p_end_date out nocopy date
76 );
77 --
78 -- ----------------------------------------------------------------------------
79 -- |-----------------------< update_ame_transaction_type >--------------------|
80 -- ----------------------------------------------------------------------------
81 --
82 -- {Start Of Comments}
83 /*#
84 * This API updates a given transaction type.
85 *
86 * <p><b>Licensing</b><br>
87 * This API is available for use with any licensed component of the
88 * e-business suite.
89 *
90 * <p><b>Prerequisites</b><br>
91 * The application_id which identifies the transaction type should be valid.
92 *
93 * <p><b>Post Success</b><br>
94 * The transaction type is updated.
95 *
96 * <p><b>Post Failure</b><br>
97 * The transaction type is not updated and an error is raised.
98 *
99 * @param p_validate If true, then validation alone will be performed and the
100 * database will remain unchanged. If false and all validation checks pass,
101 * then the database will be modified.
102 * @param p_language_code Specifies to which language the translation values
103 * apply. You can set to the base or any installed language. The default value
104 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
105 * value.
106 * @param p_application_name The new name of the transaction type.
107 * @param p_application_id This uniquely identifies the transaction type
108 * to be updated.
109 * @param p_object_version_number Pass in the current version number of the
110 * transaction type to be updated. When the API completes, if p_validate is
111 * false, it will be set to the new version number of the updated
112 * transaction type. If p_validate is true, will be set to the same value
113 * which was passed in.
114 * @param p_start_date If p_validate is false, It is set to present date.
115 * If p_validate is true, it is set to null.
116 * @param p_end_date It is the date upto which the updated transaction type
117 * is effective. If p_validate is false, it is set to 31-Dec-4712.
118 * If p_validate is true, it is set to null.
119 * @rep:displayname Update Transaction Type
120 * @rep:category BUSINESS_ENTITY AME_TRANSACTION_TYPE
121 * @rep:lifecycle active
122 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
123 * @rep:scope public
124 */
125 --
126 -- {End Of Comments}
127 --
128 procedure update_ame_transaction_type
129 (p_validate in boolean default false
130 ,p_language_code in varchar2 default hr_api.userenv_lang
131 ,p_application_name in varchar2 default hr_api.g_varchar2
132 ,p_application_id in number
133 ,p_object_version_number in out nocopy number
134 ,p_start_date out nocopy date
135 ,p_end_date out nocopy date
136 );
137 --
138 -- ----------------------------------------------------------------------------
139 -- |-----------------------< delete_ame_transaction_type >--------------------|
140 -- ----------------------------------------------------------------------------
141 --
142 -- {Start Of Comments}
143 /*#
144 * This API deletes a given transaction type.
145 *
146 * <p><b>Licensing</b><br>
147 * This API is available for use with any licensed component of the
148 * e-business suite.
149 *
150 * <p><b>Prerequisites</b><br>
151 * The application_id which identifies the transaction type should be valid.
152 *
153 * <p><b>Post Success</b><br>
154 * The transaction type is deleted.
155 *
156 * <p><b>Post Failure</b><br>
157 * The transaction type is not deleted and an error is raised.
158 *
159 * @param p_validate If true, then validation alone will be performed and the
160 * database will remain unchanged. If false and all validation checks pass,
161 * then the database will be modified.
162 * @param p_application_id This uniquely identifies the transaction type
163 * to be deleted.
164 * @param p_object_version_number Pass in the current version number of the
165 * transaction type to be deleted. When the API completes, if p_validate
166 * is false, it will be set to the new version number of the deleted
167 * transaction type. If p_validate is true, will be set to the same value
168 * which was passed in.
169 * @param p_start_date If p_validate is false, it is set to the date from
170 * which the deleted transaction type was effective. If p_validate is true,
171 * it is set to null.
172 * @param p_end_date If p_validate is false, it is set to present date.
173 * If p_validate is true, it is set to null.
174 * @rep:displayname Delete Transaction Type
175 * @rep:category BUSINESS_ENTITY AME_TRANSACTION_TYPE
176 * @rep:lifecycle active
177 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
178 * @rep:scope public
179 */
180 --
181 -- {End Of Comments}
182 --
183 procedure delete_ame_transaction_type
184 (p_validate in boolean default false
185 ,p_application_id in number
186 ,p_object_version_number in out nocopy number
187 ,p_start_date out nocopy date
188 ,p_end_date out nocopy date
189 );
190 --
191 end AME_TRANS_TYPE_API;
[Home] [Help]