1 Package HR_AUTHORIA_MAPPING_API as
2 /* $Header: hrammapi.pkh 120.1 2005/10/02 01:58:49 aroussel $ */
3 /*#
4 * This package contains APIs that maintain mapping information for the
5 * Authoria integration.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Authoria Mapping
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-------------------------< create_authoria_mapping >----------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates the mapping between Oracle HRMS and Authoria Interface.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * The benefits plan and option in plan must have been created.
25 *
26 * <p><b>Post Success</b><br>
27 * The Authoria mapping has successfully been created.
28 *
29 * <p><b>Post Failure</b><br>
30 * The Authoria mapping has not been created and raises an error.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_pl_id {@rep:casecolumn BEN_PL_F.PL_ID}
35 * @param p_plip_id {@rep:casecolumn BEN_PLIP_F.PLIP_ID}
36 * @param p_open_enrollment_flag Indicator for open enrollment. Valid values
37 * can be Y or N.
38 * @param p_target_page Authoria target page name.
39 * @param p_authoria_mapping_id If p_validate is false, then this uniquely
40 * identifies the authoria mapping created. If p_validate is true, then set to
41 * null.
42 * @param p_object_version_number If p_validate is false, then set to the
43 * version number of the created mapping. If p_validate is true, then the value
44 * will be null.
45 * @rep:displayname Create Authoria Mapping
46 * @rep:category BUSINESS_ENTITY HR_AUTHORIA_INTEGRATION_MAP
47 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
48 * @rep:scope public
49 * @rep:lifecycle active
50 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
51 */
52 --
53 -- {End Of Comments}
54 --
55 procedure create_authoria_mapping
56 (p_validate in boolean default false
57 ,p_pl_id in number
58 ,p_plip_id in number default null
59 ,p_open_enrollment_flag in varchar2
60 ,p_target_page in varchar2
61 ,p_authoria_mapping_id out nocopy number
62 ,p_object_version_number out nocopy number
63 );
64 --
65 -- ----------------------------------------------------------------------------
66 -- |-------------------------< update_authoria_mapping >----------------------|
67 -- ----------------------------------------------------------------------------
68 --
69 -- {Start Of Comments}
70 /*#
71 * This API updates the Authoria Mapping.
72 *
73 *
74 * <p><b>Licensing</b><br>
75 * This API is licensed for use with Human Resources.
76 *
77 * <p><b>Prerequisites</b><br>
78 * The AUTHORIA_MAPPING_ID must exist within the HR_AUTHORIA_MAPPINGS table.
79 *
80 * <p><b>Post Success</b><br>
81 * The API will successfully update the mapping.
82 *
83 * <p><b>Post Failure</b><br>
84 * This API does not update the mapping for the third party and raises an
85 * error.
86 * @param p_validate If true, then validation alone will be performed and the
87 * database will remain unchanged. If false and all validation checks pass,
88 * then the database will be modified.
89 * @param p_target_page Authoria target page name.
90 * @param p_authoria_mapping_id Uniquely identifies the Authoria mapping record
91 * to update.
92 * @param p_pl_id {@rep:casecolumn BEN_PL_F.PL_ID}
93 * @param p_plip_id {@rep:casecolumn BEN_PLIP_F.PLIP_ID}
94 * @param p_open_enrollment_flag Indicates whether the Authoria page can be
95 * used within an open benefits enrollment period. Valid values are Y or N.
96 * @param p_object_version_number Pass in the current version number of the
97 * Authoria mapping to be updated. When the API completes if p_validate is
98 * false, will be set to the new version number of the updated Authoria
99 * mapping. If p_validate is true will be set to the same value which was
100 * passed in.
101 * @rep:displayname Update Authoria Mapping
102 * @rep:category BUSINESS_ENTITY HR_AUTHORIA_INTEGRATION_MAP
103 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
104 * @rep:scope public
105 * @rep:lifecycle active
106 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
107 */
108 --
109 -- {End Of Comments}
110 --
111 procedure update_authoria_mapping
112 (p_validate in boolean default false
113 ,p_target_page in varchar2
114 ,p_authoria_mapping_id in number
115 ,p_pl_id in number
116 ,p_plip_id in number default HR_API.G_NUMBER
117 ,p_open_enrollment_flag in varchar2
118 ,p_object_version_number in out nocopy number
119 );
120 --
121 -- ----------------------------------------------------------------------------
122 -- |-------------------------< delete_authoria_mapping >----------------------|
123 -- ----------------------------------------------------------------------------
124 --
125 -- {Start Of Comments}
126 /*#
127 * This API deletes the Authoria Mapping.
128 *
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 * The AUTHORIA_MAPPING_ID must exist within the HR_AUTHORIA_MAPPINGS table.
135 *
136 * <p><b>Post Success</b><br>
137 * The Authoria mapping will be successfully deleted from the database.
138 *
139 * <p><b>Post Failure</b><br>
140 * The Authoria mapping will not be deleted and an error will be raised.
141 * @param p_validate If true, then validation alone will be performed and the
142 * database will remain unchanged. If false and all validation checks pass,
143 * then the database will be modified.
144 * @param p_authoria_mapping_id Uniquely identifies the Authoria mapping record
145 * to delete.
146 * @param p_object_version_number Current version number of the Authoria
147 * mapping to be deleted.
148 * @rep:displayname Delete Authoria Mapping
149 * @rep:category BUSINESS_ENTITY HR_AUTHORIA_INTEGRATION_MAP
150 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
151 * @rep:scope public
152 * @rep:lifecycle active
153 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
154 */
155 --
156 -- {End Of Comments}
157 --
158 procedure DELETE_AUTHORIA_MAPPING
159 (p_validate in boolean default false
160 ,p_authoria_mapping_id in number
161 ,p_object_version_number in number
162 );
163 --
164 --
165 end HR_AUTHORIA_MAPPING_API;
[Home] [Help]