1 Package hxc_alias_definitions_api as
2 /* $Header: hxchadapi.pkh 120.0 2005/05/29 05:32:25 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_alias_definition >---------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --
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 a new alias definition is
20 -- created. The default is FALSE.
21 -- p_alias_definition_name Yes varchar2 Name for the alias
22 -- p_timecard_field Yes varchar2 The field on the timecard
23 -- for which this alias will
24 -- be used.
25 -- p_description No varchar2 User description of the alias
26 --
27 -- p_prompt No varchar2 Prompt for the alternate Name
28 -- defined.
29 -- p_alias_type_id Yes Number ID of the alternate Name Type.
30 --
31 -- Post Success:
32 --
33 -- The following OUT parameters are set after the alias definition
34 -- has been created successfully:
35 --
36 -- Name Type Description
37 -- p_alias_definition_id number Primary Key for entity
38 -- p_object_version_number number Object Version Number
39 --
40 -- Post Failure:
41 --
42 -- The alias definition will not be created and an application error will be
43 -- raised.
44 --
45 -- Access Status:
46 -- Public.
47 --
48 -- {End Of Comments}
49 --
50 procedure create_alias_definition
51 (p_validate in boolean default false
52 ,p_alias_definition_id out nocopy number
53 ,p_alias_definition_name in varchar2
54 ,p_alias_context_code in varchar2 default null
55 ,p_business_group_id in number default null
56 ,p_legislation_code in varchar2 default null
57 ,p_description in varchar2 default null
58 ,p_prompt in varchar2 default null
59 ,p_timecard_field in varchar2
60 ,p_object_version_number out nocopy number
61 ,p_language_code in varchar2 default hr_api.userenv_lang
62 ,p_alias_type_id in number
63 -- ,p_effective_date in date
64 -- ,p_non_mandatory_arg in number default null
65 -- ,p_some_warning out boolean
66 );
67 --
68 -- ----------------------------------------------------------------------------
69 -- |--------------------------< update_alias_definition >---------------------|
70 -- ----------------------------------------------------------------------------
71 -- {Start Of Comments}
72 --
73 -- Description:
74 -- This API updates an existing alias definition.
75 --
76 -- Prerequisites:
77 -- None.
78 --
79 -- In Parameters:
80 -- Name Reqd Type Description
81 -- p_validate No Boolean If TRUE then the database
82 -- remains unchanged. If FALSE
83 -- then the alias definition is
84 -- updated. The default is FALSE.
85 -- p_alias_definition_id Yes number Primary Key for entity
86 -- p_alias_definition_name Yes varchar2 Name for the alias
87 -- p_timecard_field Yes varchar2 The field on the timecard
88 -- for which this alias will
89 -- be used.
90 -- p_description No varchar2 User description of the alias
91 -- p_prompt No varchar2 Prompt for the alternate Name
92 -- defined.
93 -- p_alias_type_id Yes Number ID of the alternate Name Type.
94 --
95 -- p_object_version_number No number Object Version Number of the
96 -- existing record.
97 --
98 -- Post Success:
99 --
100 -- The following OUT parameters are set, after the alias definition has
101 -- been updated successfully:
102 --
103 -- Name Type Description
104 -- p_object_version_number number Object Version Number of the
105 -- updated record.
106 --
107 -- Post Failure:
108 --
109 -- The alias definition will not be updated and an application error will be
110 -- raised.
111 --
112 -- Access Status:
113 -- Public.
114 --
115 -- {End Of Comments}
116 --
117 procedure update_alias_definition
118 (p_validate in boolean default false
119 ,p_alias_definition_id in number
120 ,p_alias_definition_name in varchar2
121 ,p_alias_context_code in varchar2 default null
122 ,p_business_group_id in number default null
123 ,p_legislation_code in varchar2 default null
124 ,p_description in varchar2 default null
125 ,p_prompt in varchar2 default null
126 ,p_timecard_field in varchar2
127 ,p_object_version_number in out nocopy number
128 ,p_language_code in varchar2 default hr_api.userenv_lang
129 ,p_alias_type_id in number
130 );
131 --
132 -- ----------------------------------------------------------------------------
133 -- |--------------------------< delete_alias_definition >---------------------|
134 -- ----------------------------------------------------------------------------
135 -- {Start Of Comments}
136 --
137 -- Description:
138 -- This API deletes an existing alias definition.
139 --
140 -- Prerequisites:
141 -- None.
142 --
143 -- In Parameters:
144 -- Name Reqd Type Description
145 -- p_validate No boolean If TRUE then the database
146 -- remains unchanged. If FALSE
147 -- then the alias definition.
148 -- is deleted. Default is FALSE.
149 -- p_alias_definition_id Yes number Primary Key for entity
150 -- p_object_version_number Yes number Object Version Number
151 --
152 -- Post Success:
153 --
154 -- If the alias definition has been deleted successfully the process
155 -- completes with success, with no OUT parameters being set.
156 --
157 -- Post Failure:
158 --
159 -- The alias definition will not be deleted and an application error is
160 -- raised.
161 --
162 -- Access Status:
163 -- Public.
164 --
165 -- {End Of Comments}
166 --
167 procedure delete_alias_definition
168 (p_validate in boolean default false
169 ,p_alias_definition_id in number
170 ,p_object_version_number in number
171 );
172 --
173 end hxc_alias_definitions_api;
[Home] [Help]