PACKAGE: APPS.PAY_BAL_ATTRIBUTE_DEFAULT_API

Source

1 Package PAY_BAL_ATTRIBUTE_DEFAULT_API as
2 /* $Header: pypbdapi.pkh 120.1 2005/10/02 02:32:32 aroussel $ */
3 /*#
4  * This package creates the pay balance attribute default.
5  * @rep:scope public
6  * @rep:product per
7  * @rep:displayname Balance Attribute Default
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_bal_attribute_default >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16  * This API creates the balance attribute default.
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  * Requires a valid business group to be exist. Also requires balance category,
24  * balance dimension and balance attribute.
25  *
26  * <p><b>Post Success</b><br>
27  * The balance attribute definition will be successfully inserted into the
28  * database.
29  *
30  * <p><b>Post Failure</b><br>
31  * The API does not create the balance attribute default and raises an error.
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_balance_category_id Foreign key to PAY_BALANCE_CATEGORIES
36  * @param p_balance_dimension_id Foreign key to PAY_BALANCE_DIMENSIONS
37  * @param p_attribute_id Foreign key to PAY_BAL_ATTRIBUTE_DEFINITIONS
38  * @param p_business_group_id Business Group of the Record.
39  * @param p_legislation_code Legislation Code
40  * @param p_bal_attribute_default_id If p_validate is false, this uniquely
41  * identifies the balance attribute default created. If p_validate is set to
42  * true, this parameter will be null.
43  * @rep:displayname Create Balance Attribute Default
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_bal_attribute_default
54   (p_validate                      in     boolean  default false
55   ,p_balance_category_id           in     number
56   ,p_balance_dimension_id          in     number
57   ,p_attribute_id                  in     number
58   ,p_business_group_id             in     number   default null
59   ,p_legislation_code              in     varchar2 default null
60   ,p_bal_attribute_default_id         out nocopy number
61   );
62 --
63 -- ----------------------------------------------------------------------------
64 -- |-----------------------< delete_bal_attribute_default >-------------------|
65 -- ----------------------------------------------------------------------------
66 --
67 -- {Start Of Comments}
68 /*#
69  * This API deletes the balance attribute default.
70  *
71  *
72  * <p><b>Licensing</b><br>
73  * This API is licensed for use with Human Resources.
74  *
75  * <p><b>Prerequisites</b><br>
76  * The balance attribute default as identified by the in parameter
77  * p_bal_attribute_default_id must already exist.
78  *
79  * <p><b>Post Success</b><br>
80  * The balance attribute default as identified by the in parameter
81  * p_bal_attribute_default_id will be deleted.
82  *
83  * <p><b>Post Failure</b><br>
84  * The API does not delete the balance attribute default and raises an error.
85  * @param p_validate If true, then validation alone will be performed and the
86  * database will remain unchanged. If false and all validation checks pass,
87  * then the database will be modified.
88  * @param p_bal_attribute_default_id {@rep:casecolumn
89  * PAY_BAL_ATTRIBUTE_DEFAULTS.BAL_ATTRIBUTE_DEFAULT_ID}
90  * @param p_business_group_id Business Group of the Record.
91  * @param p_legislation_code Legislation Code
92  * @rep:displayname Delete Balance Attribute Default
93  * @rep:category BUSINESS_ENTITY PAY_BALANCE
94  * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
95  * @rep:scope public
96  * @rep:lifecycle active
97  * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
98 */
99 --
100 -- {End Of Comments}
101 --
102 procedure delete_bal_attribute_default
103   (p_validate                      in     boolean  default false
104   ,p_bal_attribute_default_id      in     number
105   ,p_business_group_id             in     number   default null
106   ,p_legislation_code              in     varchar2 default null
107   );
108 
109 end PAY_BAL_ATTRIBUTE_DEFAULT_API;