1 Package hr_name_format_api as
2 /* $Header: hrnmfapi.pkh 120.7.12010000.2 2008/08/06 08:44:08 ubhat ship $ */
3 /*#
4 * This package contains enhancement for name format functionality.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Name Format
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_name_format >---------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a new name format.
17 *
18 * This procedure will provide an interface to create named format masks for
19 * a legislation.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Human resources.
23 *
24 * <p><b>Prerequisites</b><br>
25 * None.
26 *
27 * <p><b>Post Success</b><br>
28 * The API will create named format masks for a legislation.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not update the name format and raises an error.
32 *
33 * @param p_validate If true, then validation alone will be performed and
34 * the database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_effective_date Effective date of the change of status.
37 * @param p_format_name User identifier for name format.
38 * @param p_user_format_choice User Format Choice of the name format mask
39 * (G or L).
40 * @param p_format_mask Actual mask used to create names according to
41 * format.
42 * @param p_legislation_code Legislation applicable for format.
43 * @param p_name_format_id If p_validate is set to false,then this uniquely
44 * identifies the new record, else it contains null.
45 * @param p_object_version_number If p_validate is set to false,then
46 * this uniquely identifies the person name format record else it contains null.
47 * @rep:displayname Create Name Format
48 * @rep:category BUSINESS_ENTITY HR_PERSON
49 * @rep:lifecycle active
50 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
51 * @rep:scope public
52 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
53 */
54 --
55 -- {End Of Comments}
56 --
57 Procedure create_name_format
58 (p_validate in boolean default false
59 ,p_effective_date in date
60 ,p_format_name in varchar2
61 ,p_user_format_choice in varchar2
62 ,p_format_mask in varchar2
63 ,p_legislation_code in varchar2
64 ,p_name_format_id out nocopy number
65 ,p_object_version_number out nocopy number
66 );
67 --
68 -- ----------------------------------------------------------------------------
69 -- |--------------------------< update_name_format >--------------------------|
70 -- ----------------------------------------------------------------------------
71 --
72 -- {Start Of Comments}
73 /*#
74 * This API updates an existing Name format.
75 *
76 * This procedure will provide an interface to update named format masks for
77 * a legislation. The name, legislation and User Format Choice themselves
78 * will not be updateable.
79 *
80 * <p><b>Licensing</b><br>
81 * This API is licensed for use with Human resources.
82 *
83 * <p><b>Prerequisites</b><br>
84 * None.
85 *
86 * <p><b>Post Success</b><br>
87 * The API will update named format masks for a legislation.
88 *
89 * <p><b>Post Failure</b><br>
90 * The API does not update the name format and raises an error.
91 *
92 * @param p_validate If true, then validation alone will be performed and
93 * the database will remain unchanged. If false and all validation checks pass,
94 * then the database will be modified.
95 * @param p_effective_date Effective date of the change of status.
96 * @param p_name_format_id Format name id.
97 * @param p_format_mask Actual mask used to update names according to
98 * format.
99 * @param p_object_version_number If p_validate is set to false,then
100 * this uniquely identifies the person name format record else it contains null.
101 * @rep:displayname Update Name Format
102 * @rep:category BUSINESS_ENTITY HR_PERSON
103 * @rep:lifecycle active
104 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
105 * @rep:scope public
106 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
107 */
108 --
109 -- {End Of Comments}
110 --
111 procedure update_name_format
112 (p_validate in boolean default false
113 ,p_effective_date in date
114 ,p_name_format_id in number
115 ,p_format_mask in varchar2
116 ,p_object_version_number in out nocopy number
117 );
118 --
119 -- ----------------------------------------------------------------------------
120 -- |--------------------------< delete_name_format >--------------------------|
121 -- ----------------------------------------------------------------------------
122 --
123 -- {Start Of Comments}
124 /*#
125 * This API deletes an existing Name format.
126 *
127 * This procedure will provide an interface to delete named format masks for
128 * a legislation.
129 *
130 * <p><b>Licensing</b><br>
131 * This API is licensed for use with Human resources.
132 *
133 * <p><b>Prerequisites</b><br>
134 * None.
135 *
136 * <p><b>Post Success</b><br>
137 * The API will delete named format masks for a legislation.
138 *
139 * <p><b>Post Failure</b><br>
140 * The API does not delete the name format and raises an error.
141 *
142 * @param p_validate If true, then validation alone will be performed and
143 * the database will remain unchanged. If false and all validation checks pass,
144 * then the database will be modified.
145 * @param p_name_format_id Format name id.
146 * @param p_object_version_number If p_validate is set to false,then
147 * this uniquely identifies the person name format record else it contains null.
148 * @rep:displayname Delete Name Format
149 * @rep:category BUSINESS_ENTITY HR_PERSON
150 * @rep:lifecycle active
151 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
152 * @rep:scope public
153 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
154 */
155 --
156 -- {End Of Comments}
157 --
158 procedure delete_name_format
159 (p_validate in boolean default false
160 ,p_name_format_id in number
161 ,p_object_version_number in out nocopy number
162 );
163 --
164 --
165 end hr_name_format_api;
[Home] [Help]