1 Package hxc_recurring_periods_api as
2 /* $Header: hxchrpapi.pkh 120.1 2005/10/02 02:06:51 aroussel $ */
3 /*#
4 * This package contains Recurring Periods APIs.
5 * @rep:scope public
6 * @rep:product hxt
7 * @rep:displayname Recurring Period
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_recurring_periods >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates the Recurring Periods required by the Time Store.
17 *
18 * The Recurring Periods created here are used across the OTL application as
19 * Timecard Periods, Approval Periods, and overtime Recurring Periods.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Time and Labor.
23 *
24 * <p><b>Prerequisites</b><br>
25 * The table PER_TIME_PERIOD_TYPES should have been created.
26 *
27 * <p><b>Post Success</b><br>
28 * The Recurring Periods will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The Recurring Periods will not be created and an application error will be
32 * raised.
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_recurring_period_id Primary Key of the new Recurring Periods.
37 * @param p_object_version_number If P_VALIDATE is false, then set the version
38 * number of the created Recurring Periods. If P_VALIDATE is true, then the
39 * value will be null.
40 * @param p_name Name of the Recurring Periods.
41 * @param p_period_type Select a Period Type if it is a Recurring Periods.
42 * @param p_duration_in_days Duration of a period. For example, the number of
43 * days in the Recurring Periods.
44 * @param p_start_date Start Date for the Recurring Periods.
45 * @param p_end_date End Date for the Recurring Periods.
46 * @param p_effective_date Not used in the Create API. Passed in as NULL.
47 * @rep:displayname Create Recurring Period
48 * @rep:category BUSINESS_ENTITY HXC_TIMECARD_RECURRING_PERIOD
49 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
50 * @rep:scope public
51 * @rep:lifecycle active
52 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
53 */
54 --
55 -- {End Of Comments}
56 --
57 procedure create_recurring_periods
58 (p_validate in boolean default false
59 ,p_recurring_period_id in out nocopy number
60 ,p_object_version_number in out nocopy number
61 ,p_name in varchar2
62 ,p_period_type in varchar2 default null
63 ,p_duration_in_days in number default null
64 ,p_start_date in date
65 ,p_end_date in date default null
66 ,p_effective_date in date default null
67 );
68 --
69 -- ----------------------------------------------------------------------------
70 -- |-------------------------< update_recurring_periods >---------------------|
71 -- ----------------------------------------------------------------------------
72 --
73 -- {Start Of Comments}
74 /*#
75 * This API updates an existing Recurring Periods.
76 *
77 * The updates created are valid, irrespective of any dates determining when
78 * the change took place.
79 *
80 * <p><b>Licensing</b><br>
81 * This API is licensed for use with Time and Labor.
82 *
83 * <p><b>Prerequisites</b><br>
84 * The Recurring Periods must exist.
85 *
86 * <p><b>Post Success</b><br>
87 * The Recurring Periods will be updated successfully in the database.
88 *
89 * <p><b>Post Failure</b><br>
90 * The Recurring Periods will not be updated and an application error will be
91 * raised.
92 * @param p_validate If true, then validation alone will be performed and the
93 * database will remain unchanged. If false and all validation checks pass,
94 * then the database will be modified.
95 * @param p_recurring_period_id Primary Key for entity.
96 * @param p_object_version_number Pass in the current version number of the
97 * Recurring Periods to be updated. When the API completes, if P_VALIDATE is
98 * false, then this will be set to the new version number of the updated
99 * Recurring Periods. If P_VALIDATE is true, then this will be set to the same
100 * value that was passed.
101 * @param p_name Name of the Recurring Periods.
102 * @param p_period_type Update a Period Type if it is a Recurring Periods and
103 * its Period Type needs to be changed.
104 * @param p_duration_in_days Duration of a period.
105 * @param p_start_date Start Date for the Recurring Periods.
106 * @param p_end_date End Date for the Recurring Periods.
107 * @param p_effective_date Not used.
108 * @rep:displayname Update Recurring Period
109 * @rep:category BUSINESS_ENTITY HXC_TIMECARD_RECURRING_PERIOD
110 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
111 * @rep:scope public
112 * @rep:lifecycle active
113 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
114 */
115 --
116 -- {End Of Comments}
117 --
118 procedure update_recurring_periods
119 (p_validate in boolean default false
120 ,p_recurring_period_id in number
121 ,p_object_version_number in out nocopy number
122 ,p_name in varchar2
123 ,p_period_type in varchar2 default null
124 ,p_duration_in_days in number default null
125 ,p_start_date in date default null
126 ,p_end_date in date default null
127 ,p_effective_date in date default null
128 );
129 --
130 -- ----------------------------------------------------------------------------
131 -- |-------------------------< delete_recurring_periods >---------------------|
132 -- ----------------------------------------------------------------------------
133 --
134 -- {Start Of Comments}
135 /*#
136 * This API deletes an existing Recurring Periods.
137 *
138 * There is a check which verifies if the Recurring Periods being deleted is a
139 * system data or a period that is being referenced across the OTL application.
140 * If yes, the deletion of the Recurring Periods will not be allowed.
141 *
142 * <p><b>Licensing</b><br>
143 * This API is licensed for use with Time and Labor.
144 *
145 * <p><b>Prerequisites</b><br>
146 * The Recurring Periods must exist.
147 *
148 * <p><b>Post Success</b><br>
149 * The Recurring Periods will be successfully deleted from the database.
150 *
151 * <p><b>Post Failure</b><br>
152 * The Recurring Periods will not be deleted and an application error will be
153 * raised.
154 * @param p_validate If true, then validation alone will be performed and the
155 * database will remain unchanged. If false and all validation checks pass,
156 * then the database will be modified.
157 * @param p_recurring_period_id Primary Key for entity.
158 * @param p_object_version_number Current version number of the Recurring
159 * Periods to be deleted.
160 * @rep:displayname Delete Recurring Period
161 * @rep:category BUSINESS_ENTITY HXC_TIMECARD_RECURRING_PERIOD
162 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
163 * @rep:scope public
164 * @rep:lifecycle active
165 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
166 */
167 --
168 -- {End Of Comments}
169 --
170 procedure delete_recurring_periods
171 (p_validate in boolean default false
172 ,p_recurring_period_id in number
173 ,p_object_version_number in number
174 );
175 --
176 --
177 END hxc_recurring_periods_api;
[Home] [Help]