1 Package OTA_TCC_API AUTHID CURRENT_USER as
2 /* $Header: ottccapi.pkh 120.1 2005/10/02 02:08:08 aroussel $ */
3 /*#
4 * This package contains the APIs to create and update a cross charge.
5 * @rep:scope public
6 * @rep:product ota
7 * @rep:displayname Cross Charge
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_cross_charge >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates an internal cross charge by mapping Chart of Account
17 * details from Oracle General Ledger to Oracle Human Resources.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Learning Management.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The Set of Books and the business group should exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The cross charge will be successfully created.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API does not create a cross charge, and raises an error.
31 * @param p_effective_date Reference date for validating lookup values are
32 * applicable during the start to end active date range. This date does not
33 * determine when the changes take effect.
34 * @param p_business_group_id The business group owning the cross charge.
35 * @param p_gl_set_of_books_id Foreign key to GL_SETS_OF_BOOKS.
36 * @param p_type The type of Cross charge. Valid values are defined by
37 * 'OTA_CROSS_CHARGE_TYPE' lookup type.
38 * @param p_from_to Source of the cross charge. Valid values are defined by
39 * 'OTA_CROSS_CHARGE_FROM_TO' lookup type.
40 * @param p_start_date_active The date on which the cross charge definition
41 * becomes active.
42 * @param p_end_date_active The date on which the cross charge definition ends.
43 * @param p_cross_charge_id If p_validate is false, then this uniquely
44 * identifies the cross charge created. If p_validate is true, then set to
45 * null.
46 * @param p_object_version_number If p_validate is false, then set to the
47 * version number of the created cross charge. If p_validate is true, then the
48 * value will be null.
49 * @param p_validate If true, then only validation will be performed and the
50 * database remains unchanged. If false, then all validation checks pass the
51 * database will be modified.
52 * @rep:displayname Create Cross Charge
53 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CROSS_CHARGE
54 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
55 * @rep:scope public
56 * @rep:lifecycle active
57 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
58 */
59 --
60 -- {End Of Comments}
61 --
62 procedure create_cross_charge
63 (p_effective_date in date
64 ,p_business_group_id in number
65 ,p_gl_set_of_books_id in number
66 ,p_type in varchar2
67 ,p_from_to in varchar2
68 ,p_start_date_active in date
69 ,p_end_date_active in date default null
70 ,p_cross_charge_id out nocopy number
71 ,p_object_version_number out nocopy number
72 ,p_validate in boolean default false
73 );
74 --
75 -- ----------------------------------------------------------------------------
76 -- |---------------------------< update_cross_charge >------------------------|
77 -- ----------------------------------------------------------------------------
78 --
79 -- {Start Of Comments}
80 /*#
81 * This API updates the cross charge details.
82 *
83 *
84 * <p><b>Licensing</b><br>
85 * This API is licensed for use with Learning Management.
86 *
87 * <p><b>Prerequisites</b><br>
88 * The cross charge should exist.
89 *
90 * <p><b>Post Success</b><br>
91 * The cross charge will be successfully updated.
92 *
93 * <p><b>Post Failure</b><br>
94 * The API does not update the cross charge, and raises an error.
95 * @param p_effective_date Reference date for validating lookup values are
96 * applicable during the start to end active date range. This date does not
97 * determine when the changes take effect.
98 * @param p_cross_charge_id This parameter uniquely identifies the cross charge
99 * being updated.
100 * @param p_object_version_number Pass in the current version number of the
101 * cross charge to be updated. When the API completes, if p_validate is false,
102 * will be set to the new version number of the updated cross charge. If
103 * p_validate is true will be set to the same value which is passed in.
104 * @param p_business_group_id The business group owning the cross charge.
105 * @param p_gl_set_of_books_id Foreign key to GL_SETS_OF_BOOKS.
106 * @param p_type The type of Cross Charge. Valid values are defined by the
107 * 'OTA_CROSS_CHARGE_TYPE' lookup type.
108 * @param p_from_to Source of the cross charge. Valid values are defined by the
109 * 'OTA_CROSS_CHARGE_FROM_TO' lookup type.
110 * @param p_start_date_active The date on which the cross charge definition
111 * becomes active.
112 * @param p_end_date_active The date on which the cross charge definition ends.
113 * @param p_validate If true, then only validation will be performed and the
114 * database remains unchanged. If false, then all validation checks pass and
115 * the database will be modified.
116 * @rep:displayname Update Cross Charge
117 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CROSS_CHARGE
118 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
119 * @rep:scope public
120 * @rep:lifecycle active
121 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
122 */
123 --
124 -- {End Of Comments}
125 --
126 procedure update_cross_charge
127 (p_effective_date in date
128 ,p_cross_charge_id in number
129 ,p_object_version_number in out nocopy number
130 ,p_business_group_id in number default hr_api.g_number
131 ,p_gl_set_of_books_id in number default hr_api.g_number
132 ,p_type in varchar2 default hr_api.g_varchar2
133 ,p_from_to in varchar2 default hr_api.g_varchar2
134 ,p_start_date_active in date default hr_api.g_date
135 ,p_end_date_active in date default hr_api.g_date
136 ,p_validate in boolean default false
137 );
138
139
140 end OTA_TCC_API;
[Home] [Help]