1 Package hr_security_payrolls_api as
2 /* $Header: hrsprapi.pkh 120.3.12010000.1 2008/07/28 03:49:03 appldev ship $ */
3 /*#
4 * This package contains APIs for Security Payroll.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Security Payroll
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< create_pay_security_payroll >-----------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This api creates a new security payroll
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Payroll.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The security profile id and payroll id must already exist.
23 *
24 * <p><b>Post Success</b><br>
25 * The API inserts payroll successfully.
26 *
27 * <p><b>Post Failure</b><br>
28 * The API does not insert payroll and raises an error
29 *
30 * @param p_validate If true, then validation alone will be performed and
31 * the database will remain unchanged. If false and all validation checks pass,
32 * then the database will be modified.
33 * @param p_effective_date Reference date for validating lookup values
34 * are applicable during the start to end active date range. This date
35 * does not determine when the changes take effect.
36 * @param p_security_profile_id Identifies the security profile record for which
37 * the security payroll is to be created.
38 * @param p_payroll_id Identifies the payroll record for which the security payroll
39 * is to be created.
40 * @param p_object_version_number The version of the newly created row.
41 * @rep:displayname Create Security Payroll
42 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_DEFINITION
43 * @rep:lifecycle active
44 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
45 * @rep:scope public
46 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
47 */
48 --
49 -- {End Of Comments}
50 --
51 procedure create_pay_security_payroll
52 (p_validate in boolean default false
53 ,p_effective_date in date
54 ,p_security_profile_id in number
55 ,p_payroll_id in number
56 ,p_object_version_number out nocopy number
57 );
58 --
59 --
60 -- --------------------------------------------------------------------------
61 -- |-----------------------< delete_pay_security_payroll >-----------------|
62 -- --------------------------------------------------------------------------
63 --
64 /*#
65 * This api deletes a security payroll
66 *
67 * <p><b>Licensing</b><br>
68 * This API is licensed for use with Payroll.
69 *
70 * <p><b>Prerequisites</b><br>
71 * The security profile id and payroll id must already exist.
72 *
73 * <p><b>Post Success</b><br>
74 * When payroll id is valid, the API deletes the security profile.
75 *
76 * <p><b>Post Failure</b><br>
77 * The API does not delete payroll and raises an error
78 *
79 * @param p_validate If true, then validation alone will be performed and
80 * the database will remain unchanged. If false and all validation checks pass,
81 * then the database will be modified.
82 * @param p_security_profile_id Identifies the security profile record for which
83 * the security payroll is to be deleted.
84 * @param p_payroll_id Identifies the payroll record for which the security
85 * payroll is to be deleted.
86 * @param p_object_version_number Current version number of the security payroll
87 * to be deleted
88 * @rep:displayname Delete Security Payroll
89 * @rep:category BUSINESS_ENTITY PAY_PAYROLL_DEFINITION
90 * @rep:lifecycle active
91 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
92 * @rep:scope public
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure delete_pay_security_payroll
99 (p_validate in boolean default false
100 ,p_security_profile_id in number
101 ,p_payroll_id in number
102 ,p_object_version_number in number
103 );
104 --
105
106 end hr_security_payrolls_api;
[Home] [Help]