1 Package hxc_alias_type_comp_api as
2 /* $Header: hxcatcapi.pkh 120.0 2005/05/29 05:26:46 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_alias_type_comp >--------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- Creates alias type components.
11 --
12 -- Prerequisites:
13 --
14 --
15 -- In Parameters:
16 -- Name Reqd Type Description
17 -- p_validate No boolean If TRUE then the database
18 -- remains unchanged. If FALSE
19 -- then the alias type component
20 -- is not created. Default is FALSE.
21 -- p_component_name Yes in name of the component.
22 -- p_component_type Yes in Indicates the type of the component.
23 -- p_mapping_component_id Yes in Id of the mapping component.
24 -- p_alias_type_id Yes in Id of the alias type associated.
25 --
26 --
27 -- Post Success:
28 --
29 --When the alias type is updated properly the following parameters are set.
30 -- Name Type Description
31 -- p_alias_type_component_id Out Id of the mapping defined.
32 -- p_object_version_number Out Object version number of the
33 -- mapping defined.
34
35 -- Post Failure:
36 -- Alias type component is not defined and raise an application error.
37
38 -- Access Status:
39 -- Public.
40 --
41 -- {End Of Comments}
42 --
43 procedure create_alias_type_comp
44 (p_validate in boolean default false
45 ,p_component_name in varchar2
46 ,p_component_type in varchar2
47 ,p_mapping_component_id in number
48 ,p_alias_type_id in number
49 ,p_alias_type_component_id out nocopy number
50 ,p_object_version_number out nocopy number
51 );
52 --
53 --
54 -- ----------------------------------------------------------------------------
55 -- |--------------------------< update_alias_type_comp>--------------------------|
56 -- ----------------------------------------------------------------------------
57 -- {Start Of Comments}
58 --
59 -- Description:
60 -- Updates alias type components.
61 --
62 -- Prerequisites:
63 --
64 --
65 -- In Parameters:
66 -- Name Reqd Type Description
67 -- p_validate No boolean If TRUE then the database
68 -- remains unchanged. If FALSE
69 -- then the alias type component
70 -- is not updated. Default is FALSE.
71 -- p_component_name Yes in name of the component.
72 -- p_component_type Yes in Indicates the type of the component.
73 -- p_mapping_component_id Yes in Id of the mapping component.
74 -- p_alias_type_id Yes in Id of the alias type associated.
75 -- p_alias_type_component_id Yes Out Id of the mapping defined.
76 --
77 --
78 -- Post Success:
79 --
80 --When the alias type is updated properly the following parameters are set.
81 -- Name Type Description
82
83 -- p_object_version_number Out Object version number of the
84 -- mapping defined.
85
86 -- Post Failure:
87 -- Alias type component is not defined and raise an application error.
88
89 -- Access Status:
90 -- Public.
91 --
92 -- {End Of Comments}
93 --
94 procedure update_alias_type_comp
95 (p_validate in boolean default false
96 ,p_component_name in varchar2
97 ,p_component_type in varchar2
98 ,p_mapping_component_id in number
99 ,p_alias_type_id in number
100 ,p_alias_type_component_id in number
101 ,p_object_version_number in out nocopy number
102 );
103
104 -- ----------------------------------------------------------------------------
105 -- |--------------------------< delete_alias_type_comp>------------------------|
106 -- ----------------------------------------------------------------------------
107 -- {Start Of Comments}
108 --
109 -- Description:
110 -- Deletes alias type components.
111 --
112 -- Prerequisites:
113 --
114 --
115 -- In Parameters:
116 -- Name Reqd Type Description
117 -- p_validate No boolean If TRUE then the database
118 -- remains unchanged. If FALSE
119 -- then the alias type component
120 -- is not updated. Default is FALSE.
121 -- p_alias_type_component_id Yes in alias type component id of
122 -- the alias type component to be
123 -- deleted
124 -- p_object_version_number Yes in Object version number of the
125 -- mapping to be deleted.
126 --
127 -- Post Success:
128 --
129 -- Post Failure:
130 -- Alias type component is not deleted and raise an application error.
131
132 -- Access Status:
133 -- Public.
134 --
135 -- {End Of Comments}
136 --
137 procedure delete_alias_type_comp
138 (p_validate in boolean default false
139 ,p_alias_type_component_id in number
140 ,p_object_version_number in number
141 );
142
143 end hxc_alias_type_comp_api;