1 Package PAY_BAL_ATTRIB_DEFINITION_API AUTHID CURRENT_USER as
2 /* $Header: pyatdapi.pkh 120.1 2005/10/02 02:29:17 aroussel $ */
3 /*#
4 * This package contains Pay Balance Attribute definition APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Balance Attribute Definition
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-----------------------< create_bal_attrib_definition >-------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the balance attribute definition.
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 exist.
24 *
25 * <p><b>Post Success</b><br>
26 * The balance adjustment will be successfully carried out.
27 *
28 * <p><b>Post Failure</b><br>
29 * The API does not create the balance attribute definition and raises an
30 * 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_effective_date Determines when the DateTrack operation comes into
35 * force.
36 * @param p_attribute_name The name for the balance attribute.
37 * @param p_business_group_id Business Group of the Record.
38 * @param p_legislation_code Legislation Code
39 * @param p_alterable Indicates if the attribute value can be altered by the
40 * user for a balance.
41 * @param p_user_attribute_name This is the display name for the attribute.
42 * @param p_attribute_id If p_validate is false, this uniquely identifies the
43 * balance attribute definition created. If p_validate is set to true, this
44 * parameter will be null.
45 * @rep:displayname Create Balance Attribute Definition
46 * @rep:category BUSINESS_ENTITY PAY_BALANCE
47 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
48 * @rep:scope public
49 * @rep:lifecycle active
50 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
51 */
52 --
53 -- {End Of Comments}
54 --
55 procedure create_bal_attrib_definition
56 (p_validate in boolean default false
57 ,p_effective_date in date
58 ,p_attribute_name in varchar2
59 ,p_business_group_id in number default null
60 ,p_legislation_code in varchar2 default null
61 ,p_alterable in varchar2 default null
62 ,p_user_attribute_name in varchar2 default null
63 ,p_attribute_id out nocopy number
64 );
65 --
66 -- ----------------------------------------------------------------------------
67 -- |-----------------------< delete_bal_attrib_definition >-------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- {Start Of Comments}
71 /*#
72 * This API deletes the balance attribute definition.
73 *
74 *
75 * <p><b>Licensing</b><br>
76 * This API is licensed for use with Human Resources.
77 *
78 * <p><b>Prerequisites</b><br>
79 * The balance attribute definition as identified by the in parameter
80 * p_attribute_id must already exist.
81 *
82 * <p><b>Post Success</b><br>
83 * The balance attribute definition as identified by the in parameter
84 * p_attribute_id will be deleted.
85 *
86 * <p><b>Post Failure</b><br>
87 * The API does not delete the balance attribute definition and raises an
88 * error.
89 * @param p_validate If true, then validation alone will be performed and the
90 * database will remain unchanged. If false and all validation checks pass,
91 * then the database will be modified.
92 * @param p_attribute_id {@rep:casecolumn
93 * PAY_BAL_ATTRIBUTE_DEFINITIONS.ATTRIBUTE_ID}
94 * @param p_business_group_id Business Group of the Record.
95 * @param p_legislation_code Legislation Code
96 * @rep:displayname Delete Balance Attribute Definition
97 * @rep:category BUSINESS_ENTITY PAY_BALANCE
98 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
99 * @rep:scope public
100 * @rep:lifecycle active
101 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
102 */
103 --
104 -- {End Of Comments}
105 --
106 procedure delete_bal_attrib_definition
107 (p_validate in boolean default false
108 ,p_attribute_id in number
109 ,p_business_group_id in number default null
110 ,p_legislation_code in varchar2 default null
111 );
112
113 end PAY_BAL_ATTRIB_DEFINITION_API;
[Home] [Help]