1 Package hxc_mapping_component_api AUTHID CURRENT_USER as
2 /* $Header: hxcmpcapi.pkh 120.0 2005/05/29 05:47:50 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_mapping_component>-----------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- {Start Of Comments}
9 --
10 -- Description:
11 --
12 -- This API creates a Mapping Component. The user is ablel to specify a name
13 -- for the component and the application field name the component relates
14 -- to.
15 --
16 -- Prerequisites:
17 --
18 -- None
19 --
20 -- In Parameters:
21 -- Name Reqd Type Description
22 --
23 -- p_validate No boolean If TRUE then the database
24 -- remains unchanged. If FALSE
25 -- then a new mapping_component
26 -- is created. Default is FALSE.
27 -- p_mapping_component_id No number Primary Key for entity
28 -- p_object_version_number No number Object Version Number
29 -- p_name Yes varchar2 Name for the mapping component
30 -- p_field_name Yes varchar2 Field Name for the mapping component
31 -- p_bld_blk_info_type_id Yes number bld_blk_info_type_id from
32 -- HXC_BLD_BLK_INFO_TYPE_USAGES
33 -- p_segment Yes varchar2 segment from the table
34 -- FND_DESCR_FLEX_COLUMN_USAGES
35 --
36 -- Post Success:
37 --
38 -- when the mapping_component has been created successfully the following
39 -- out parameters are set.
40 --
41 -- Name Type Description
42 --
43 -- p_mapping_component_id Number Primary Key for the new rule
44 -- p_object_version_number Number Object version number for the
45 -- new rule
46 --
47 -- Post Failure:
48 --
49 -- The mapping component will not be inserted and an application error raised
50 --
51 -- Access Status:
52 -- Public.
53 --
54 -- {End Of Comments}
55 --
56 procedure create_mapping_component
57 (p_validate in boolean default false
58 ,p_mapping_component_id in out nocopy number
59 ,p_object_version_number in out nocopy number
60 ,p_name in varchar2
61 ,p_field_name in varchar2
62 ,p_bld_blk_info_type_id in number
63 ,p_segment in varchar2
64 );
65 --
66 -- ----------------------------------------------------------------------------
67 -- |------------------------<update_mapping_component>------------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- {Start Of Comments}
71 --
72 -- Description:
73 --
74 -- This API updates an existing Mapping Component with a given name, approval
75 -- rule usage covering a particular date range.
76 --
77 -- Prerequisites:
78 --
79 -- None
80 --
81 -- In Parameters:
82 -- Name Reqd Type Description
83 --
84 -- p_validate No boolean If TRUE then the database
85 -- remains unchanged. If FALSE
86 -- then the mapping_component
87 -- is updated. Default is FALSE.
88 -- p_mapping_component_id Yes number Primary Key for entity
89 -- p_object_version_number Yes number Object Version Number
90 -- p_name Yes varchar2 Name for the mapping component
91 -- p_field_name Yes varchar2 Field Name for the mapping component
92 -- p_bld_blk_info_type_id Yes number building block info type id from
93 -- HXC_BLD_BLK_INFO_TYPE_USAGES
94 -- p_segment Yes varchar2 segment from the table
95 -- FND_DESCR_FLEX_COLUMN_USAGES
96 -- Post Success:
97 --
98 -- when the mapping_component has been updated successfully the following
99 -- out parameters are set.
100 --
101 -- Name Type Description
102 --
103 -- p_object_version_number Number Object version number for the
104 -- updated rule
105 --
106 -- Post Failure:
107 --
108 -- The mapping component will not be updated and an application error raised
109 --
110 -- Access Status:
111 -- Public.
112 --
113 -- {End Of Comments}
114 --
115 procedure update_mapping_component
116 (p_validate in boolean default false
117 ,p_mapping_component_id in number
118 ,p_object_version_number in out nocopy number
119 ,p_name in varchar2
120 ,p_field_name in varchar2
121 ,p_bld_blk_info_type_id in number
122 ,p_segment in varchar2
123 );
124 --
125 -- ----------------------------------------------------------------------------
126 -- |------------------------< delete_mapping_component >---------------------|
127 -- ----------------------------------------------------------------------------
128 --
129 -- {Start Of Comments}
130 --
131 -- Description:
132 --
133 -- This API deletes an existing Mapping Component
134 --
135 -- Prerequisites:
136 --
137 -- None
138 --
139 -- In Parameters:
140 -- Name Reqd Type Description
141 --
142 -- p_validate No boolean If TRUE then the database
143 -- remains unchanged. If FALSE
144 -- then the mapping_component
145 -- is deleted. Default is FALSE.
146 -- p_mapping_component_id Yes number Primary Key for entity
147 -- p_object_version_number Yes number Object Version Number
148 --
149 -- Post Success:
150 --
151 -- when the mapping_component has been deleted successfully the process
152 -- completes with success.
153 --
154 -- Post Failure:
155 --
156 -- The mapping component will not be deleted and an application error raised
157 --
158 -- Access Status:
159 -- Public.
160 --
161 -- {End Of Comments}
162 --
163 procedure delete_mapping_component
164 (p_validate in boolean default false
165 ,p_mapping_component_id in number
166 ,p_object_version_number in number
167 );
168 --
169 --
170 END hxc_mapping_component_api;
[Home] [Help]