DBA Data[Home] [Help]

PACKAGE: APPS.PQH_TXN_CAT_ATTRIBUTES_API

Source


1 Package pqh_TXN_CAT_ATTRIBUTES_api AUTHID CURRENT_USER as
2 /* $Header: pqtcaapi.pkh 120.1 2005/10/02 02:28:20 aroussel $ */
3 /*#
4  * This package contains transaction category attribute API.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Transaction Category Attribute
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_TXN_CAT_ATTRIBUTE >------------------------|
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_attribute_id                 Yes  number    Descriptive Flexfield
24 --   p_transaction_category_id      Yes  number
25 --   p_value_set_id                 No   number
26 --   p_transaction_table_route_id   No   number
27 --   p_form_column_name             No   varchar2
28 --   p_identifier_flag              No   varchar2
29 --   p_list_identifying_flag        No   varchar2
30 --   p_member_identifying_flag      No   varchar2
31 --   p_refresh_flag                 No   varchar2
32 --   p_select_flag                  No   varchar2
33 --   p_value_style_cd               No   varchar2
34 --   p_effective_date           Yes  date      Session Date.
35 --
36 -- Post Success:
37 --
38 -- Out Parameters:
39 --   Name                                Type     Description
40 --   p_txn_category_attribute_id    Yes  number    Descriptive Flexfield
41 --   p_object_version_number        Yes  number    OVN of record
42 --
43 -- Post Failure:
44 --
45 -- Access Status:
46 --   Public.
47 --
48 -- {End Of Comments}
49 --
50 procedure create_TXN_CAT_ATTRIBUTE
51 (
52    p_validate                       in boolean    default false
53   ,p_txn_category_attribute_id      out nocopy number
54   ,p_attribute_id                   in  number
55   ,p_transaction_category_id        in  number
56   ,p_value_set_id                   in  number    default null
57   ,p_object_version_number          out nocopy number
58   ,p_transaction_table_route_id     in  number    default null
59   ,p_form_column_name               in  varchar2  default null
60   ,p_identifier_flag                in  varchar2  default null
61   ,p_list_identifying_flag          in  varchar2  default null
62   ,p_member_identifying_flag        in  varchar2  default null
63   ,p_refresh_flag                   in  varchar2  default null
64   ,p_select_flag                    in  varchar2  default null
65   ,p_value_style_cd                 in  varchar2
66   ,p_effective_date            in  date
67  );
68 --
69 -- ----------------------------------------------------------------------------
70 -- |-------------------------< update_txn_cat_attribute >---------------------|
71 -- ----------------------------------------------------------------------------
72 --
73 -- {Start Of Comments}
74 /*#
75  * This API allows updating transaction category attribute details.
76  *
77  * Each transaction type has its own unique set of attributes available and the
78  * details of these attributes can be updated. Some of these transaction
79  * category attributes can be selected for defining routing and approval rules,
80  * which are then applied to position, budget, or reallocation transactions.
81  *
82  * <p><b>Licensing</b><br>
83  * This API is licensed for use with Human Resources.
84  *
85  * <p><b>Prerequisites</b><br>
86  * The transaction type to which the attributes belong must be in unfrozen
87  * status.
88  *
89  * <p><b>Post Success</b><br>
90  * The transaction category attribute is successfully updated in the database.
91  *
92  * <p><b>Post Failure</b><br>
93  * The transaction category attribute is not updated and an error is raised.
94  * @param p_validate If true, then validation alone will be performed and the
95  * database will remain unchanged. If false and all validation checks pass,
96  * then the database will be modified.
97  * @param p_txn_category_attribute_id Identifies the transaction category
98  * attribute record to modify.
99  * @param p_attribute_id Identifies the attribute which is associated with a
100  * transaction type.
101  * @param p_transaction_category_id Obsolete parameter, do not use.
102  * @param p_value_set_id Identifies the value set against which values entered
103  * for this attribute must be validated in routing and approval rules.
104  * @param p_object_version_number Pass in the current version number of the
105  * transaction category attribute to be updated. When the API completes if
106  * p_validate is false, will be set to the new version number of the updated
107  * transaction category attribute. If p_validate is true will be set to the
108  * same value which was passed in.
109  * @param p_transaction_table_route_id Identifies the table to which the
110  * attribute belongs.
111  * @param p_form_column_name Identifies the form field which maps to the
112  * transaction category attribute.
113  * @param p_identifier_flag Indicates if the attribute can be selected for
114  * defining routing/approval rules. Valid values are defined by 'YES_NO' lookup
115  * type.
116  * @param p_list_identifying_flag Indicates if the attribute is used in the
117  * transaction type for defining routing rules. Valid values are defined by
118  * 'YES_NO' lookup type.
119  * @param p_member_identifying_flag Indicates if the attribute is used in the
120  * transaction type for defining approval rules. Valid values are defined by
121  * 'YES_NO' lookup type.
122  * @param p_refresh_flag Indicates if the attribute value should be refreshed
123  * from the master record when the attribute value in the transaction is
124  * different from the value in the master record and the attribute value was
125  * not updated by a user in the transaction record. Valid values are defined by
126  * 'YES_NO' lookup type.
127  * @param p_select_flag Indicates if the attribute can be selected as a
128  * template attribute. In case of Position copy and Mass Processes, this flag
129  * indicates if the attribute is used processing. Valid values are defined by
130  * 'YES_NO' lookup type.
131  * @param p_value_style_cd Indicates if the attribute value should be entered
132  * as a range or as an exact value.
133  * @param p_effective_date Reference date for validating lookup values are
134  * applicable during the start to end active date range. This date does not
135  * determine when the changes take effect.
136  * @param p_delete_attr_ranges_flag Indicates if the routing rules defined
137  * using an attribute must be deleted, when this attribute is updated to be no
138  * longer used as list identifier. Similarly, this flag indicates if the
139  * approval rules defined using an attribute must be deleted, when this
140  * attribute is updated to be no longer used as member identifier.
141  * @rep:displayname Update Transaction Category Attribute
142  * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
143  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
144  * @rep:scope public
145  * @rep:lifecycle active
146  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
147 */
148 --
149 -- {End Of Comments}
150 --
151 procedure update_TXN_CAT_ATTRIBUTE
152   (
153    p_validate                       in boolean    default false
154   ,p_txn_category_attribute_id      in  number
155   ,p_attribute_id                   in  number    default hr_api.g_number
156   ,p_transaction_category_id        in  number    default hr_api.g_number
157   ,p_value_set_id                   in  number    default hr_api.g_number
158   ,p_object_version_number          in out nocopy number
159   ,p_transaction_table_route_id     in  number    default hr_api.g_number
160   ,p_form_column_name               in  varchar2  default hr_api.g_varchar2
161   ,p_identifier_flag                in  varchar2  default hr_api.g_varchar2
162   ,p_list_identifying_flag          in  varchar2  default hr_api.g_varchar2
163   ,p_member_identifying_flag        in  varchar2  default hr_api.g_varchar2
164   ,p_refresh_flag                   in  varchar2  default hr_api.g_varchar2
165   ,p_select_flag                    in  varchar2  default hr_api.g_varchar2
166   ,p_value_style_cd                 in  varchar2
167   ,p_effective_date                 in  date
168   ,p_delete_attr_ranges_flag        in  varchar2  default hr_api.g_varchar2
169   );
170 --
171 -- ----------------------------------------------------------------------------
172 -- |------------------------< delete_TXN_CAT_ATTRIBUTE >------------------------|
173 -- ----------------------------------------------------------------------------
174 -- {Start Of Comments}
175 --
176 -- Description:
177 --
178 -- Prerequisites:
179 --
180 --
181 -- In Parameters:
182 --   Name                           Reqd Type     Description
183 --   p_validate                     Yes  boolean  Commit or Rollback.
184 --   p_txn_category_attribute_id    Yes  number    Descriptive Flexfield
185 --   p_effective_date          Yes  date     Session Date.
186 --
187 -- Post Success:
188 --
189 --   Name                           Type     Description
190 --   p_object_version_number        Yes  number    OVN of record
191 --
192 -- Post Failure:
193 --
194 -- Access Status:
195 --   Public.
196 --
197 -- {End Of Comments}
198 --
199 procedure delete_TXN_CAT_ATTRIBUTE
200   (
201    p_validate                       in boolean        default false
202   ,p_txn_category_attribute_id      in number
203   ,p_object_version_number          in number
204   ,p_effective_date                 in date
205   );
206 --
207 --
208 end pqh_TXN_CAT_ATTRIBUTES_api;