1 Package PAY_BALANCE_ATTRIBUTE_API as
2 /* $Header: pypbaapi.pkh 120.1 2005/10/02 02:32:22 aroussel $ */
3 /*#
4 * Pay Balance Attribute API.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Balance Attribute
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_balance_attribute >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This >API creates the balance attribute.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Human Resources.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The defined balance and balance attribute must exists for the same business
24 * group as this record is to be created.
25 *
26 * <p><b>Post Success</b><br>
27 * The balance attribute will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create the balance attribute raises an error.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_attribute_id {@rep:casecolumn
35 * PAY_BAL_ATTRIBUTE_DEFINITIONS.ATTRIBUTE_ID}
36 * @param p_defined_balance_id {@rep:casecolumn
37 * PAY_DEFINED_BALANCES.DEFINED_BALANCE_ID}
38 * @param p_business_group_id Business Group of the Record.
39 * @param p_legislation_code Legislation Code
40 * @param p_balance_attribute_id If p_validate is false, this uniquely
41 * identifies the balance attribute created. If p_validate is set to true, this
42 * parameter will be null.
43 * @rep:displayname Create Balance Attribute
44 * @rep:category BUSINESS_ENTITY PAY_BALANCE
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:lifecycle active
48 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
49 */
50 --
51 -- {End Of Comments}
52 --
53 procedure create_balance_attribute
54 (p_validate in boolean default false
55 ,p_attribute_id in number
56 ,p_defined_balance_id in number
57 ,p_business_group_id in number default null
58 ,p_legislation_code in varchar2 default null
59 ,p_balance_attribute_id out nocopy number
60 );
61 --
62 -- ----------------------------------------------------------------------------
63 -- |-------------------------< delete_balance_attribute >---------------------|
64 -- ----------------------------------------------------------------------------
65 --
66 -- {Start Of Comments}
67 /*#
68 * This API deletes a balance attribute.
69 *
70 *
71 * <p><b>Licensing</b><br>
72 * This API is licensed for use with Human Resources.
73 *
74 * <p><b>Prerequisites</b><br>
75 * The balance attribute as identified by the in parameter
76 * p_balance_attribute_id must already exist.
77 *
78 * <p><b>Post Success</b><br>
79 * The balance attribute as identified by the in parameter
80 * p_balance_attribute_id will be deleted.
81 *
82 * <p><b>Post Failure</b><br>
83 * The API does not delete the balance attribute and raises an error.
84 * @param p_validate If true, then validation alone will be performed and the
85 * database will remain unchanged. If false and all validation checks pass,
86 * then the database will be modified.
87 * @param p_balance_attribute_id {@rep:casecolumn
88 * PAY_BALANCE_ATTRIBUTES.BALANCE_ATTRIBUTE_ID}
89 * @param p_business_group_id Business Group of the Record.
90 * @param p_legislation_code Legislation Code
91 * @rep:displayname Delete Balance Attribute
92 * @rep:category BUSINESS_ENTITY PAY_BALANCE
93 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
94 * @rep:scope public
95 * @rep:lifecycle active
96 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
97 */
98 --
99 -- {End Of Comments}
100 --
101 procedure delete_balance_attribute
102 (p_validate in boolean default false
103 ,p_balance_attribute_id in number
104 ,p_business_group_id in number default null
105 ,p_legislation_code in varchar2 default null
106 );
107
108 end PAY_BALANCE_ATTRIBUTE_API;
[Home] [Help]