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