1 Package hr_document_types_api AUTHID CURRENT_USER as
2 /* $Header: hrdtyapi.pkh 120.4 2008/03/27 09:32:29 ubhat noship $ */
3 /*#
4 * This package contains API for document type maintenance.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Document Type
8 */
9 --
10 -- -----------------------------------------------------------------------------------
11 -- |--------------------------< create_document_type >--------------------------|
12 -- -----------------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API creates a document type.
16 *
17 * <p><b>Licensing</b><br>
18 * This API is licensed for use with Human Resource.
19 *
20 * <p><b>Prerequisites</b><br>
21 * None.
22 *
23 * <p><b>Post Success</b><br>
24 * A document type will be created.
25 *
26 * <p><b>Post Failure</b><br>
27 * A document type will not be created and an error will be raised.
28 *
29 * @param p_validate If true, then validation alone will be performed and
30 * the database will remain unchanged. If false and all validation checks pass,
31 * then the database will be modified.
32 * @param p_language_code Specifies to which language the translation
33 * values apply. You can set to the base or any installed language. The default
34 * value of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG')
35 * function value.
36 * @param p_description Description of the docuement type being created.
37 * @param p_document_type Document Type.
38 * @param p_effective_date Reference date for validating lookup values are
39 * applicable during the start to end active date range. This date does not
40 * determine when the changes take effect.
41 * @param p_category_code The Category Code for the Document Type.
42 * @param p_active_inactive_flag The flag determines whether the Document
43 * Type defined is active or inactive.
44 * @param p_multiple_occurences_flag The flag determines whether multiple
45 * documents of this Document Type can exist in the database.
46 * @param p_authorization_required Determines whether authorization is
47 * required for this Document Type.
48 * @param p_sub_category_code The Subcategory Code for the Document Type.
49 * @param p_legislation_code The Legislation Code for the Document Type.
50 * @param p_warning_period Warning Period in number of days before the
51 * document of this type expires.
52 * @param p_request_id When the API is executed from a concurrent program
53 * set to the concurrent request identifier.
54 * @param p_program_application_id When the API is executed from a
55 * concurrent program set to the program's Application.
56 * @param p_program_id When the API is executed from a concurrent program
57 * set to the program's identifier.
58 * @param p_program_update_date When the API is executed from a concurrent
59 * program set to when the program was ran.
60 * @param p_document_type_id If p_validate is false, then it uniquely
61 * identifies the document of record created. If p_validate is true, then set to null.
62 * @param p_object_version_number If p_validate is false, then it is set to the
63 * version number of the created document extra information.
64 * If p_validate is true, it will be set to null.
65 * @rep:displayname Create Document Type
66 * @rep:category BUSINESS_ENTITY HR_PERSON
67 * @rep:lifecycle active
68 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
69 * @rep:scope public
70 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
71 */
72 --
73 -- {End Of Comments}
74 --
75 procedure create_document_type(
76 p_validate in boolean default false
77 ,p_language_code IN VARCHAR2 DEFAULT hr_api.userenv_lang
78 ,p_description in varchar2 default null
79 ,p_document_type in varchar2
80 ,p_effective_date in date default sysdate
81 ,p_category_code in varchar2
82 ,p_active_inactive_flag in varchar2
83 ,p_multiple_occurences_flag in varchar2
84 ,p_authorization_required in varchar2
85 ,p_sub_category_code in varchar2 default null
86 ,p_legislation_code in varchar2 default null
87 ,p_warning_period in number default null
88 ,p_request_id in number default null
89 ,p_program_application_id in number default null
90 ,p_program_id in number default null
91 ,p_program_update_date in date default sysdate
92 ,p_document_type_id out nocopy number
93 ,p_object_version_number out nocopy number
94 );
95 --
96 --
97 -- ----------------------------------------------------------------------------
98 -- |-------------------------< update_document_type >---------------------|
99 -- ----------------------------------------------------------------------------
100 -- {Start Of Comments}
101 /*#
102 * This API updates the document types.
103 *
104 * <p><b>Licensing</b><br>
105 * This API is licensed for use with Human Resource.
106 *
107 * <p><b>Prerequisites</b><br>
108 * Document Type must exist.
109 *
110 * <p><b>Post Success</b><br>
111 * A document type will be updated.
112 *
113 * <p><b>Post Failure</b><br>
114 * A document type will not be updated and an error will be raised.
115 *
116 * @param p_validate If true, then validation alone will be performed and
117 * the database will remain unchanged. If false and all validation checks
118 * pass, then the database will be modified.
119 * @param p_effective_date Reference date for validating lookup values
120 * are applicable during the start to end active date range. This date does
121 * not determine when the changes take effect.
122 * @param p_language_code Specifies to which language the translation
123 * values apply. You can set to the base or any installed language. The default
124 * value of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG')
125 * function value.
126 * @param p_description Description of the Document Type
127 * @param p_document_type Defines the Basic Document Type
128 * @param p_document_type_id This uniquely identifies the Document Type.
129 * @param p_object_version_number Pass in the current version number of
130 * the document of record to be updated. When the API completes if p_validate
131 * is false, will be set to the new version number of the updated document of
132 * record. If p_validate is true will be set to the same value which was
133 * passed in.
134 * @param p_category_code The Category Code for the Document Type.
135 * @param p_active_inactive_flag The flag determines whether the Document
136 * Type defined is active or inactive.
137 * @param p_multiple_occurences_flag The flag determines whether multiple
138 * documents of this Document Type can exist in the database.
139 * @param p_legislation_code The Legislation Code for the Document Type.
140 * @param p_authorization_required The flag determines whether
141 * authorization is required for that Document Type.
142 * @param p_sub_category_code The Sub Category Code for the Document Type
143 * @param p_warning_period Warning Period in number of days before the
144 * document of this type expires.
145 * @param p_request_id When the API is executed from a concurrent program
146 * set to the concurrent request identifier.
147 * @param p_program_application_id When the API is executed from a
148 * concurrent program set to the program's Application.
149 * @param p_program_id When the API is executed from a concurrent program
150 * set to the program's identifier.
151 * @param p_program_update_date When the API is executed from a concurrent
152 * program set to when the program was ran.
153 * @rep:displayname Update Document Type
154 * @rep:category BUSINESS_ENTITY HR_PERSON
155 * @rep:lifecycle active
156 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
157 * @rep:scope public
158 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
159 */
160 --
161 -- {End Of Comments}
162 --
163 procedure update_document_type(
164 p_validate in boolean default false
165 ,p_effective_date in date default sysdate
166 ,p_language_code IN VARCHAR2 DEFAULT hr_api.userenv_lang
167 ,p_description in varchar2 default hr_api.g_varchar2
168 ,p_document_type in varchar2
169 ,p_document_type_id in number
170 ,p_object_version_number in out nocopy number
171 ,p_category_code in varchar2
172 ,p_active_inactive_flag in varchar2
173 ,p_multiple_occurences_flag in varchar2
174 ,p_legislation_code in varchar2 default hr_api.g_varchar2
175 ,p_authorization_required in varchar2
176 ,p_sub_category_code in varchar2 default hr_api.g_varchar2
177 ,p_warning_period in number default hr_api.g_number
178 ,p_request_id in number default hr_api.g_number
179 ,p_program_application_id in number default hr_api.g_number
180 ,p_program_id in number default hr_api.g_number
181 ,p_program_update_date in date default hr_api.g_date
182 );
183 --
184 -- ----------------------------------------------------------------------------
185 -- |-------------------------< delete_document_type >---------------------|
186 -- ----------------------------------------------------------------------------
187 -- {Start Of Comments}
188 /*#
189 * This API deletes the document types.
190 *
191 * <p><b>Licensing</b><br>
192 * This API is licensed for use with Human Resource.
193 *
194 * <p><b>Prerequisites</b><br>
195 * Document type must exist.
196 *
197 * <p><b>Post Success</b><br>
198 * A document type will be deleted.
199 *
200 * <p><b>Post Failure</b><br>
201 * A document type will not be deleted and an error will be raised.
202 *
203 * @param p_validate If true, then validation alone will be performed and
204 * the database will remain unchanged. If false and all validation checks pass,
205 * then the database will be modified.
206 * @param p_document_type_id Id of the Document Type
207 * @param p_object_version_number Object version number of the record
208 * to be deleted.
209 * @rep:displayname Delete Document Type
210 * @rep:category BUSINESS_ENTITY HR_PERSON
211 * @rep:lifecycle active
212 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
213 * @rep:scope public
214 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
215 */
216 --
217 -- {End Of Comments}
218 --
219 procedure delete_document_type
220 (p_validate in boolean default false
221 ,p_document_type_id in number
222 ,p_object_version_number in number
223 );
224
225 end hr_document_types_api;
226 --
227 --
[Home] [Help]