1 Package irc_assignment_details_api as
2 /* $Header: iriadapi.pkh 120.5.12010000.1 2008/07/28 12:40:51 appldev ship $ */
3 /*#
4 * This package contains assignment details APIs.
5 * @rep:scope public
6 * @rep:product irc
7 * @rep:displayname Assignment Detail
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |------------------------< create_assignment_details >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates additional assignment detail values.
17 *
18 *
19 * <p><b>Licensing</b><br>
20 * This API is licensed for use with Irecruitment.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The assignment must exist on the effective date.
24 *
25 * <p><b>Post Success</b><br>
26 * The assignment details will be successfully inserted into the database.
27 *
28 * <p><b>Post Failure</b><br>
29 * The assignment details will not be created and an error will be raised.
30 *
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_effective_date Determines when the DateTrack operation comes into
35 * force.
36 * @param p_assignment_id Identifies the assignment record, whose details
37 * are being created.
38 * @param p_attempt_id Identifies the application assignment assessment
39 * attempt.
40 * @param p_qualified Identifies if the applicant is qualified.
41 * @param p_considered Identifies if the applicant is considered.
42 * @param p_assignment_details_id If p_validate is false, then this uniquely
43 * identifies the assignment detail created. If p_validate is true, then set
44 * to null.
45 * @param p_details_version If p_validate is false, then this identifies the
46 * version of the assignment detail with in the same effective date range.
47 * If p_validate is true, then set to null.
48 * @param p_effective_start_date If p_validate is false, then set to the
49 * earliest effective start date for the created assignment detail. If
50 * p_validate is true, then set to null.
51 * @param p_effective_end_date If p_validate is false, then set to the
52 * effective end date for the created assignment detail. If p_validate is true,
53 * then set to null.
54 * @param p_object_version_number If p_validate is false, then set to the
55 * version number of the created assignment detail. If p_validate is true,
56 * then the value will be null.
57 * @rep:displayname Create Assignment Detail
58 * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
59 * @rep:lifecycle active
60 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
61 * @rep:scope public
62 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
63 */
64 --
65 -- {End Of Comments}
66 --
67 procedure create_assignment_details
68 (p_validate in boolean default false
69 ,p_effective_date in date
70 ,p_assignment_id in number
71 ,p_attempt_id in number default null
72 ,p_qualified in varchar2 default null
73 ,p_considered in varchar2 default null
74 ,p_assignment_details_id out nocopy number
75 ,p_details_version out nocopy number
76 ,p_effective_start_date out nocopy date
77 ,p_effective_end_date out nocopy date
78 ,p_object_version_number out nocopy number
79 );
80 --
81 -- ----------------------------------------------------------------------------
82 -- |------------------------< update_assignment_details >---------------------|
83 -- ----------------------------------------------------------------------------
84 --
85 -- {Start Of Comments}
86 /*#
87 * This API updates additional assignment detail values.
88 *
89 *
90 * <p><b>Licensing</b><br>
91 * This API is licensed for use with Irecruitment.
92 *
93 * <p><b>Prerequisites</b><br>
94 * The assignment and assignment detail must exist on the effective date.
95 *
96 * <p><b>Post Success</b><br>
97 * The assignment details will have been updated.
98 *
99 * <p><b>Post Failure</b><br>
100 * The assignment details will not be updated and an error will be raised.
101 *
102 * @param p_validate If true, then validation alone will be performed and the
103 * database will remain unchanged. If false and all validation checks pass,
104 * then the database will be modified.
105 * @param p_effective_date Determines when the DateTrack operation comes into
106 * force.
107 * @param p_datetrack_update_mode Indicates which DateTrack mode to use when
108 * updating the record. You must set to either UPDATE, CORRECTION,
109 * UPDATE_OVERRIDE or UPDATE_CHANGE_INSERT. Modes available for use with a
110 * particular record depend on the dates of previous record changes and the
111 * effective date of this change.
112 * @param p_assignment_id Identifies the assignment record, whose details
113 * are being updated.
114 * @param p_attempt_id Identifies the application assignment assessment
115 * attempt.
116 * @param p_qualified Identifies if the applicant is qualified.
117 * @param p_considered Identifies if the applicant is considered.
118 * @param p_assignment_details_id Pass in the id of the assignment detail that
119 * will be updated. When the API completes if p_validate is false then will be
120 * set to the new assignment detail id. If p_validate is true then will be set
121 * to the passed value.
122 * @param p_object_version_number Pass in the current version number of the
123 * assignment detail to be updated. When the API completes if p_validate is
124 * false, will be set to the new version number of the updated assignment
125 * detail. If p_validate is true will be set to the same value which was
126 * passed in.
127 * @param p_details_version If p_validate is false, then this identifies the
128 * version of the assignment detail with in the same effective date range.
129 * If p_validate is true, then set to null.
130 * @param p_effective_start_date If p_validate is false, then set to the
131 * effective start date on the updated assignment detail row which now
132 * exists as of the effective date. If p_validate is true, then set to null.
133 * @param p_effective_end_date If p_validate is false, then set to the
134 * effective end date on the updated assignment detail row which now exists
135 * as of the effective date. If p_validate is true, then set to null.
136 * @rep:displayname Update Assignment Detail
137 * @rep:category BUSINESS_ENTITY PER_APPLICANT_ASG
138 * @rep:lifecycle active
139 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
140 * @rep:scope public
141 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
142 */
143 --
144 -- {End Of Comments}
145 --
146 procedure update_assignment_details
147 (p_validate in boolean default false
148 ,p_effective_date in date
149 ,p_datetrack_update_mode in varchar2
150 ,p_assignment_id in number default hr_api.g_number
151 ,p_attempt_id in number default hr_api.g_number
152 ,p_qualified in varchar2 default null
153 ,p_considered in varchar2 default null
154 ,p_assignment_details_id in out nocopy number
155 ,p_object_version_number in out nocopy number
156 ,p_details_version out nocopy number
157 ,p_effective_start_date out nocopy date
158 ,p_effective_end_date out nocopy date
159 );
160 --
161 end irc_assignment_details_api;