1 PACKAGE CAC_VIEW_ACC_DAILY_VIEW_PVT as
2 /* $Header: caccadvs.pls 120.1 2005/07/02 02:17:45 appldev noship $ */
3 /*#
4 * This package is used for accessbility daily view.
5 * @rep:scope private
6 * @rep:product CAC
7 * @rep:lifecycle active
8 * @rep:displayname Accessibility Daily View
9 * @rep:compatibility N
10 * @rep:category BUSINESS_ENTITY CAC_APPOINTMENT
11 */
12
13 /**
14 * This function extracts only time portion of start dates and
15 * returns the time as format 'HH12:MI AM'.
16 * @param p_start_date Start Date
17 * @param p_end_date End Date
18 * @return The formatted start time
19 * @rep:displayname Get start time
20 * @rep:lifecycle deprecated
21 * @rep:compatibility N
22 */
23 FUNCTION get_start_time(p_start_date IN DATE
24 ,p_end_date IN DATE)
25 RETURN VARCHAR2;
26
27 /**
28 * This function is used to convert source timezone
29 * to client timezone defined currently.
30 * @param p_server_date Date for server date
31 * @param p_source_timezone_id Source Timezone Id
32 * @return The client date
33 * @rep:displayname Get Client Data
34 * @rep:lifecycle deprecated
35 * @rep:compatibility N
36 */
37 FUNCTION get_client_date(p_server_date IN DATE
38 ,p_source_timezone_id IN NUMBER) RETURN DATE;
39
40 /**
41 * This function returns valid start date
42 * among planned, scheduled, actual and calendar start date.
43 * @param p_source_object_type_code source object type code
44 * @param p_date_selected date type selected
45 * @param p_planned_start_date planned start date
46 * @param p_scheduled_start_date scheduled start date
47 * @param p_actual_start_date actual start date
48 * @param p_calendar_start_date calendar start date
49 * @return the valid start date
50 * @rep:displayname Get Start Data
51 * @rep:lifecycle deprecated
52 * @rep:compatibility N
53 */
54 FUNCTION get_start_date(p_source_object_type_code IN VARCHAR2
55 ,p_date_selected IN VARCHAR2
56 ,p_planned_start_date IN DATE
57 ,p_scheduled_start_date IN DATE
58 ,p_actual_start_date IN DATE
59 ,p_calendar_start_date IN DATE
60 )
61 RETURN DATE;
62
63 /**
64 * This function returns valid end date
65 * among planned, scheduled, actual and calendar end date.
66 * @param p_source_object_type_code source object type code
67 * @param p_date_selected date type selected
68 * @param p_planned_end_date planned end date
69 * @param p_scheduled_end_date scheduled end date
70 * @param p_actual_end_date actual end date
71 * @param p_calendar_end_date calendar end date
72 * @return the valid end date
73 * @rep:displayname Get End Data
74 * @rep:lifecycle deprecated
75 * @rep:compatibility N
76 */
77 FUNCTION get_end_date(p_source_object_type_code IN VARCHAR2
78 ,p_date_selected IN VARCHAR2
79 ,p_planned_end_date IN DATE
80 ,p_scheduled_end_date IN DATE
81 ,p_actual_end_date IN DATE
82 ,p_calendar_end_date IN DATE
83 )
84 RETURN DATE;
85
86 /**
87 * This function returns the duration in minutes.
88 * @param p_source_object_type_code source object type code
89 * @param p_date_selected date type selected
90 * @param p_planned_start_date planned start date
91 * @param p_planned_end_date planned end date
92 * @param p_scheduled_start_date scheduled start date
93 * @param p_scheduled_end_date scheduled end date
94 * @param p_actual_start_date actual start date
95 * @param p_actual_end_date actual end date
96 * @param p_calendar_start_date calendar start date
97 * @param p_calendar_end_date calendar end date
98 * @return The duration
99 * @rep:displayname Get Duration
100 * @rep:lifecycle deprecated
101 * @rep:compatibility N
102 */
103 FUNCTION get_duration(p_source_object_type_code IN VARCHAR2
104 ,p_date_selected IN VARCHAR2
105 ,p_planned_start_date IN DATE
106 ,p_planned_end_date IN DATE
107 ,p_scheduled_start_date IN DATE
108 ,p_scheduled_end_date IN DATE
109 ,p_actual_start_date IN DATE
110 ,p_actual_end_date IN DATE
111 ,p_calendar_start_date IN DATE
112 ,p_calendar_end_date IN DATE
113 )
114 RETURN VARCHAR2;
115
116 /**
117 * This function returns the descriptive duration string, ex. 30 Minutes.
118 * @param p_duration_min duration in minute
119 * @return The descriptive duration in string
120 * @rep:displayname Get descriptive duration
121 * @rep:lifecycle active
122 * @rep:compatibility N
123 */
124 FUNCTION to_duration(p_duration_min IN NUMBER) RETURN VARCHAR2;
125
126 /**
127 * This function returns the descriptive reminder string
128 * based on the given reminder in minute.
129 * The following minutes are defined in the lookup type JTF_CALND_REMIND_ME.
130 *
131 * Minute Reminder Text
132 * ------- ------------------
133 * 0 Do Not Remind Me
134 * 5 5 Minutes Before
135 * 10 10 Minutes Before
136 * 15 15 Minutes Before
137 * 30 30 Minutes Before
138 * 60 1 Hour Before
139 * 120 2 Hours Before
140 * 1440 1 Day Before
141 * 2880 2 Days Before
142 * 4320 3 Days Before
143 * 10080 1 Week Before
144 * @param p_reminder_min Reminder in minute
145 * @return The descriptive reminder string
146 * @rep:displayname Get descriptive reminder
147 * @rep:lifecycle active
148 * @rep:compatibility N
149 */
150 FUNCTION get_reminder(p_reminder_min IN NUMBER) RETURN VARCHAR2;
151
152 /**
153 * This function returns the descriptive reminder string
154 * based on the given reminder and its unit of measuure.
155 * @param p_reminder if p_reminder_uom is null, the unit is regarded as minute
156 * @param p_reminder_uom unit of measure for reminder
157 * @return The descriptive reminder string
158 * @rep:displayname Get descriptive reminder
159 * @rep:lifecycle active
160 * @rep:compatibility N
161 */
162 FUNCTION get_reminder(p_reminder IN NUMBER
163 ,p_reminder_uom IN VARCHAR2)
164 RETURN VARCHAR2;
165
166 /**
167 * This function returns the descriptive reminder string based on task id.
168 * @param p_task_id task id
169 * @return The descriptive reminder string
170 * @rep:displayname Get descriptive reminder
171 * @rep:lifecycle active
172 * @rep:compatibility N
173 */
174 FUNCTION get_reminder(p_task_id IN NUMBER) RETURN VARCHAR2;
175
176 /**
177 * This function returns the list of attendees
178 * concatenated with comma delimit.
179 * @param p_task_id task id
180 * @return The list of attendees
181 * @rep:lifecycle active
182 * @rep:displayname Get list of attendees
183 * @rep:compatibility N
184 */
185 FUNCTION get_attendees(p_task_id IN NUMBER) RETURN VARCHAR2;
186
190 * @param p_preference_name preference name
187 /**
188 * This function returns preference value
189 * based on the given preference name
191 * @return The prefix defined for the given preference name
192 * @rep:displayname Get Prefix
193 * @rep:lifecycle deprecated
194 * @rep:compatibility N
195 */
196 FUNCTION get_prefix(p_preference_name IN VARCHAR2) RETURN VARCHAR2;
197
198 /**
199 * This function returns the subject concatenated to a prefix
200 * for event objects
201 * @param p_source_code source object code
202 * @param p_source_id source object id
203 * @return The subject concatenated to a prefix
204 * @rep:displayname Get Subject
205 * @rep:lifecycle deprecated
206 * @rep:compatibility N
207 */
208 FUNCTION get_subject(p_source_code IN VARCHAR2
209 ,p_source_id IN NUMBER) RETURN VARCHAR2;
210
211 /**
212 * This function returns the subject concatenated to a prefix
213 * for appointment objects
214 * @param p_object_code source object code
215 * @param p_object_name source object id
216 * @param p_task_id task id
217 * @param p_resource_id resource id
218 * @return The subject concatenated to a prefix
219 * @rep:displayname Get Subject
220 * @rep:lifecycle deprecated
221 * @rep:compatibility N
222 */
223 FUNCTION get_subject(p_object_code IN VARCHAR2
224 ,p_object_name IN VARCHAR2
225 ,p_task_id IN NUMBER
226 ,p_resource_id IN NUMBER)
227 RETURN VARCHAR2;
228
229 /**
230 * This function returns the descriptive repeating information
231 * @param p_object_type source object type code (Ignored)
232 * @param p_recurrence_rule_id recurrence rule id
233 * @return The descriptive repeating information
234 * @rep:displayname Get Repeating Information
235 * @rep:lifecycle active
236 * @rep:compatibility N
237 */
238 FUNCTION get_repeating(p_object_type IN VARCHAR2
239 ,p_recurrence_rule_id IN NUMBER)
240 RETURN VARCHAR2;
241
242 /**
243 * This function returns the descriptive repeating information
244 * @param p_task_id task id
245 * @return The descriptive repeating information
246 * @rep:displayname Get Repeating Information
247 * @rep:lifecycle active
248 * @rep:compatibility N
249 */
250 FUNCTION get_repeating(p_task_id IN NUMBER)
251 RETURN VARCHAR2;
252
253 /**
254 * This function returns the url information of the destination page.
255 * @param p_object_code source object type code
256 * @param p_object_id source object id
257 * @return The url information
258 * @rep:displayname Get Destination URL
259 * @rep:lifecycle deprecated
260 * @rep:compatibility N
261 */
262 FUNCTION get_destination_uri(p_object_code IN VARCHAR2
263 ,p_object_id IN NUMBER)
264 RETURN VARCHAR2;
265
266 /**
267 * This function returns a flag to indicate
268 * whether the given object should be displayed or not.
269 * @param p_object_code source object type code
270 * @return The show flag
271 * @rep:displayname Get Show Flag
272 * @rep:lifecycle deprecated
273 * @rep:compatibility N
274 */
275 FUNCTION show_flag (p_object_code IN VARCHAR2)
276 RETURN VARCHAR2;
277
278 /**
279 * This function returns SQL statement for the given object type code.
280 * @param p_object_code source object type code
281 * @return The SQL statement
282 * @rep:displayname Get SQL
283 * @rep:lifecycle active
284 * @rep:compatibility N
285 */
286 FUNCTION get_sql (p_object_type_code IN VARCHAR2)
287 RETURN VARCHAR2;
288
289 /**
290 * This function returns an object name for the given object id.
291 * @param p_sql SQL statement
292 * @param p_object_id source object id
293 * @return The object name
294 * @rep:displayname Get Object Name
295 * @rep:lifecycle active
296 * @rep:compatibility N
297 */
298 FUNCTION get_object_name (p_sql IN VARCHAR2
299 ,p_object_id IN NUMBER)
300 RETURN VARCHAR2;
301
302 /**
303 * This function returns the concatednated information
304 * of items related to the given task id.
305 * @param p_task_id task id
306 * @return The related items
307 * @rep:displayname Get Related Items
308 * @rep:lifecycle active
309 * @rep:compatibility N
310 */
311 FUNCTION get_related_items (p_task_id IN NUMBER)
312 RETURN VARCHAR2;
313
314 /**
315 * This function returns the FireAction event name
316 * related to the given task id and resource id.
317 * Returns INVITE if assignment status id is 18
318 * Returns DEFAULT if assignment status id is NOT 18
319 * @param p_task_id task id
320 * @param p_resource_id resource id
321 * @return The event name
322 * @rep:displayname Get Event Name
323 * @rep:lifecycle deprecated
324 * @rep:compatibility N
325 */
326 FUNCTION get_event_for_detail (p_task_id IN NUMBER
327 ,p_resource_id IN NUMBER)
328 RETURN VARCHAR2;
329
330 END CAC_VIEW_ACC_DAILY_VIEW_PVT;
[Home] [Help]