1 Package irc_template_association_api as
2 /* $Header: iritaapi.pkh 120.4 2008/02/21 14:28:15 viviswan noship $ */
3 /*#
4 * This package contains APIs for managing template association for an
5 * organisation or job or position.
6 * @rep:scope public
7 * @rep:product irc
8 * @rep:displayname Template Association
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |-----------------------< create_template_association >--------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a new template association.
18 *
19 * This api creates template association for an organisation, job or position.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with iRecruitment.
23 *
24 * <p><b>Prerequisites</b><br>
25 * A valid Template is required to create a new template association.
26 *
27 * <p><b>Post Success</b><br>
28 * The API creates the template association.
29 *
30 * <p><b>Post Failure</b><br>
31 * The API does not create a template association and an error is raised.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_template_id Identifies the associated template.
37 * @param p_effective_date Reference date for validating lookup values are
38 * applicable during the start to end active date range. This date does
39 * not determine when the changes take effect.
40 * @param p_default_association Identifies the default template association.
41 * @param p_job_id Identifies the job that is associated with the template
42 * association.
43 * @param p_position_id Identifies the position that is associated with
44 * the template association.
45 * @param p_organization_id Identifies the organization that is associated
46 * with the template association.
47 * @param p_start_date The start date from which the template association is
48 * in effect.
49 * @param p_end_date The last date till which the template association
50 * is active.
51 * @param p_object_version_number If p_validate is false, then set to the
52 * version number of the created template association. If p_validate is true,
53 * then the value will be null.
54 * @param p_template_association_id Primary key of the template association.
55 * @rep:displayname Create Template Association
56 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_LETTER_TEMPLATE
57 * @rep:lifecycle active
58 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
59 * @rep:scope public
60 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
61 */
62 --
63 -- {End Of Comments}
64 --
65 procedure create_template_association
66 (p_validate in boolean default false
67 ,p_template_id in number
68 ,p_effective_date in date default null
69 ,p_default_association in varchar2 default null
70 ,p_job_id in number default null
71 ,p_position_id in number default null
72 ,p_organization_id in number default null
73 ,p_start_date in date default null
74 ,p_end_date in date default null
75 ,p_object_version_number out NOCOPY number
76 ,p_template_association_id out NOCOPY number
77 );
78 --
79 -- ----------------------------------------------------------------------------
80 -- |-----------------------< update_template_association >--------------------|
81 -- ----------------------------------------------------------------------------
82 --
83 -- {Start Of Comments}
84 /*#
85 * This API updates template association for an organization, job
86 * or position.
87 *
88 *
89 * <p><b>Licensing</b><br>
90 * This API is licensed for use with iRecruitment.
91 *
92 * <p><b>Prerequisites</b><br>
93 * Template association must already exist.
94 *
95 * <p><b>Post Success</b><br>
96 * The API updates the template association.
97 *
98 * <p><b>Post Failure</b><br>
99 * Template association will not be updated and an error will be raised.
100 *
101 * @param p_validate If true, then validation alone will be performed and the
102 * database will remain unchanged. If false and all validation checks pass,
103 * then the database will be modified.
104 * @param p_effective_date Reference date for validating lookup values are
105 * applicable during the start to end active date range. This date does
106 * not determine when the changes take effect.
107 * @param p_template_association_id Identifies the template association.
108 * @param p_template_id Identifies the associated template.
109 * @param p_default_association Identifies the default tempalte association.
110 * @param p_job_id Identifies the job that is associated with the template
111 * association.
112 * @param p_position_id Identifies the position that is associated with
113 * the template association.
114 * @param p_organization_id Identifies the organization that is associated
115 * with the template association.
116 * @param p_start_date The start date from which the template association is
117 * in effect.
118 * @param p_end_date The last date till which the template association
119 * is active.
120 * @param p_object_version_number Pass in the current version number of the
121 * template association to be updated. When the API completes if p_validate is
122 * false, will be set to the new version number of the updated
123 * template association.
124 * If p_validate is true will be set to the same value which was
125 * passed in.
126 * @rep:displayname Update Template Association
127 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_LETTER_TEMPLATE
128 * @rep:lifecycle active
129 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
130 * @rep:scope public
131 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
132 */
133 --
134 -- {End Of Comments}
135 --
136 procedure update_template_association
137 ( p_validate in boolean default false
138 ,p_effective_date in date default null
139 ,p_template_association_id in number
140 ,p_template_id in number
141 ,p_default_association in varchar2 default null
142 ,p_job_id in number default null
143 ,p_position_id in number default null
144 ,p_organization_id in number default null
145 ,p_start_date in date default null
146 ,p_end_date in date default null
147 ,p_object_version_number in out NOCOPY number
148 );
149 --
150 -- ----------------------------------------------------------------------------
151 -- |-----------------------< delete_template_association >--------------------|
152 -- ----------------------------------------------------------------------------
153 --
154 -- {Start Of Comments}
155 /*#
156 * This API deletes the template association.
157 *
158 *
159 * <p><b>Licensing</b><br>
160 * This API is licensed for use with iRecruitment.
161 *
162 * <p><b>Prerequisites</b><br>
163 * Template association must already exist.
164 *
165 * <p><b>Post Success</b><br>
166 * The API deletes the template association.
167 *
168 * <p><b>Post Failure</b><br>
169 * Template association will not be deleted and an error will be raised.
170 *
171 * @param p_validate If true, then validation alone will be performed and the
172 * database will remain unchanged. If false and all validation checks pass,
173 * then the database will be modified.
174 * @param p_template_association_id Identifies the template association.
175 * @param p_object_version_number Current version number of the template
176 * association to be deleted.
177 * @rep:displayname Delete Template Association
178 * @rep:category BUSINESS_ENTITY IRC_JOB_OFFER_LETTER_TEMPLATE
179 * @rep:lifecycle active
180 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
181 * @rep:scope public
182 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
183 */
184 --
185 -- {End Of Comments}
186 --
187 procedure delete_template_association
188 (p_validate in boolean default false
189 ,p_template_association_id in number
190 ,p_object_version_number in number
191 );
192
193 --
194 end irc_template_association_api;
[Home] [Help]