1 Package OTA_THG_API as
2 /* $Header: otthgapi.pkh 120.1 2005/10/02 02:08:19 aroussel $ */
3 /*#
4 * This API maintains the detail mappings between Oracle General Ledger's Chart
5 * of Account keyflex segments and Oracle Human Resources Cost Allocation
6 * keyflex segments.
7 * @rep:scope public
8 * @rep:product ota
9 * @rep:displayname General Ledger Flexfield
10 */
11 --
12 -- ----------------------------------------------------------------------------
13 -- |----------------------------< create_hr_gl_flex >-------------------------|
14 -- ----------------------------------------------------------------------------
15 --
16 -- {Start Of Comments}
17 /*#
18 * This API creates details that enable internal cross charging by mapping
19 * Chart of Account details from Oracle General Ledger to Oracle Human
20 * Resources.
21 *
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with Learning Management.
25 *
26 * <p><b>Prerequisites</b><br>
27 * The Chart of Account Keyflex segments and Cost Allocations keyflex segments
28 * should exist.
29 *
30 * <p><b>Post Success</b><br>
31 * The details to enable cross charging will be created successfully.
32 *
33 * <p><b>Post Failure</b><br>
34 * The API does not create the mapping, and raises an error.
35 * @param p_effective_date Reference date for validating lookup values are
36 * applicable during the start to end active date range. This date does not
37 * determine when the changes take effect.
38 * @param p_cross_charge_id Foreign key to OTA_CROSS_CHARGES.
39 * @param p_segment Name of the segment in the accounting flexfield structure
40 * to which this record applies.
41 * @param p_segment_num Number of the segment in the accounting flexfield
42 * structure to which this record is applied.
43 * @param p_hr_data_source Name of the table on which this segment is based.
44 * @param p_constant Constant value for this segment.
45 * @param p_hr_cost_segment Cost Segment from Pay Cost Allocation Keyflex.
46 * @param p_gl_default_segment_id If p_validate is false, then this uniquely
47 * identifies the mapping created. If p_validate is true, then set to null.
48 * @param p_object_version_number If p_validate is false, then set to the
49 * version number of the created mapping. If p_validate is true, then the value
50 * will be null.
51 * @param p_validate If true, then only validation will be performed and the
52 * database remains unchanged. If false, then all validation checks pass and
53 * the database will be modified.
54 * @rep:displayname Create HR General Ledger Flexfield
55 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CROSS_CHARGE
56 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
57 * @rep:scope public
58 * @rep:lifecycle active
59 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
60 */
61 --
62 -- {End Of Comments}
63 --
64 procedure create_hr_gl_flex
65 (p_effective_date in date
66 ,p_cross_charge_id in number
67 ,p_segment in varchar2
68 ,p_segment_num in number
69 ,p_hr_data_source in varchar2 default null
70 ,p_constant in varchar2 default null
71 ,p_hr_cost_segment in varchar2 default null
72 ,p_gl_default_segment_id out nocopy number
73 ,p_object_version_number out nocopy number
74 ,p_validate in boolean default false
75 );
76 --
77 -- ----------------------------------------------------------------------------
78 -- |----------------------------< update_hr_gl_flex >-------------------------|
79 -- ----------------------------------------------------------------------------
80 --
81 -- {Start Of Comments}
82 /*#
83 * This API updates details that enable internal cross charging by mapping
84 * Chart of Account details from Oracle General Ledger to Oracle Human
85 * Resources.
86 *
87 *
88 * <p><b>Licensing</b><br>
89 * This API is licensed for use with Learning Management.
90 *
91 * <p><b>Prerequisites</b><br>
92 * The mapping between Chart of Account details from Oracle General Ledger to
93 * Oracle Human Resources should exist.
94 *
95 * <p><b>Post Success</b><br>
96 * The mapping is successfully updated.
97 *
98 * <p><b>Post Failure</b><br>
99 * The API does not update the mapping details, and raises an error.
100 * @param p_effective_date Reference date for validating lookup values are
101 * applicable during the start to end active date range. This date does not
102 * determine when the changes take effect.
103 * @param p_gl_default_segment_id This parameter uniquely identifies the record
104 * being updated.
105 * @param p_object_version_number Pass in the current version number of the
106 * mapping detail to be updated. When the API completes, if p_validate is
107 * false, will be set to the new version number of the updated mapping detail.
108 * If p_validate is true will be set to the same value which is passed in.
109 * @param p_cross_charge_id Foreign key to OTA_CROSS_CHARGES.
110 * @param p_segment Name of the segment in the accounting flexfield structure
111 * to which this record applies.
112 * @param p_segment_num Number of the segment in the accounting flexfield
113 * structure to which this record applies.
114 * @param p_hr_data_source Name of the table on which this segment is based.
115 * @param p_constant Constant value for this segment.
116 * @param p_hr_cost_segment Cost Segment from Pay Cost Allocation Keyflex.
117 * @param p_validate If true, then only validation will be performed and the
118 * database remains unchanged. If false, then all validation checks pass and
119 * the database will be modified.
120 * @rep:displayname Update HR General Ledger Flexfield
121 * @rep:category BUSINESS_ENTITY OTA_LEARNING_CROSS_CHARGE
122 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
123 * @rep:scope public
124 * @rep:lifecycle active
125 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
126 */
127 --
128 -- {End Of Comments}
129 --
130 procedure update_hr_gl_flex
131 (p_effective_date in date
132 ,p_gl_default_segment_id in number
133 ,p_object_version_number in out nocopy number
134 ,p_cross_charge_id in number default hr_api.g_number
135 ,p_segment in varchar2 default hr_api.g_varchar2
136 ,p_segment_num in number default hr_api.g_number
137 ,p_hr_data_source in varchar2 default hr_api.g_varchar2
138 ,p_constant in varchar2 default hr_api.g_varchar2
139 ,p_hr_cost_segment in varchar2 default hr_api.g_varchar2
140 ,p_validate in boolean default false
141 );
142
143
144 end OTA_THG_API;