1 PACKAGE CAC_VIEW_PVT AS
2 /* $Header: cacvps.pls 120.3 2006/02/22 08:35:58 sankgupt noship $ */
3 /*#
4 * This package is used for calendar view.
5 * @rep:scope private
6 * @rep:product CAC
7 * @rep:lifecycle active
8 * @rep:displayname Calendar View
9 * @rep:compatibility N
10 * @rep:category BUSINESS_ENTITY CAC_APPOINTMENT
11 */
12
13 /*******************************************************************************
14 ** Record type that holds all the information needed to display a Calendar list
15 *******************************************************************************/
16 TYPE CalLstRec IS RECORD
17 ( ResourceID NUMBER -- JTF_RESOURCE resource ID of the logged on user
18 , ResourceType VARCHAR2(30) -- JTF_RESOURCE resource type of the logged on user (save in the cookie)
19 , CalendarName VARCHAR2(360)-- Calendar display name
20 , AccessLevel VARCHAR2(80) -- Access level for the calendar
21 );
22
23 /*******************************************************************************
24 ** PL/SQL table TYPE definition for the results of the GetCalendarList procedure
25 *******************************************************************************/
26 TYPE CalLstTblType IS TABLE OF CalLstRec INDEX BY BINARY_INTEGER;
27
28 TYPE QueryIn IS RECORD
29 /*******************************************************************************
30 ** Record type that holds all the input iformation needed for the
31 ** Calendar daily/weekly/monthly view
32 *******************************************************************************/
33 ( UserID NUMBER -- FND_USER.USER_ID of the logged on user
34 , LoggedOnRSID NUMBER -- JTF_RESOURCE resource ID of the logged on user
35 , LoggedOnRSType VARCHAR2(30) -- JTF_RESOURCE resource type of the logged on user
36 , QueryRSID NUMBER -- JTF_RESOURCE resource ID of the queried user
37 , QueryRSType VARCHAR2(30) -- JTF_RESOURCE resource Type of the queried user
38 , EmpLocTimezoneID NUMBER -- The timezone id of employee location
39 , StartDate DATE -- User StartDate of days to query: NULL means user's today/this week/this month
40 , EndDate DATE -- User EndDate of days to query: NULL means user's today/this week/this month
41 , QueryMode NUMBER -- 1=daily, 2=weekly, 3=monthly
42 , ShowApts CHAR(1) -- 'Y'/'N' whether to show apts
43 , ShowTasks CHAR(1) -- 'Y'/'N' whether to show tasks
44 , ShowEvents CHAR(1) -- 'Y'/'N' whether to show events
45 , ShowOpenInvite CHAR(1) -- 'Y'/'N' whether to show open invitations
46 , ShowDeclined CHAR(1) -- 'Y'/'N' whether to show declined apts
47 , ShowBookings CHAR(1) -- 'Y'/'N' whether to show Bookings
48 , ShowHRCalendarEvents CHAR(1) -- 'Y'/'N' whether to show HR Calendar Events
49 , ShowSchedules CHAR(1) -- 'Y'/'N' whether to show Show Schedules
50 , AptFirstDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
51 , AptSecondDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
52 , AptThirdDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
53 , InvFirstDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
54 , InvSecondDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
55 , InvThirdDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
56 , DeclFirstDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
57 , DeclSecondDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
58 , DeclThirdDetail CHAR(2) -- 1 = Attendees, 2 = Location, 3 = Related Items
59 , ShowBusyTask CHAR(1)
60 , ShowFreeTask CHAR(1)
61 , ShowTentativeTask CHAR(1)
62 , TaskFirstDetail CHAR(2)
63 , TaskSecondDetail CHAR(2)
64 , TaskThirdDetail CHAR(2)
65 , UseCalendarSecurity CHAR(1) -- 'Y'/'N' whether to use security or not
66 , ViewTimezoneID NUMBER -- The timezone id passed to convert the start times into
67 );
68
69 TYPE QueryOut IS RECORD
70 /*******************************************************************************
71 ** Record type that holds all the output iformation needed for the Calendar
72 ** daily/weekly/monthly view
73 *******************************************************************************/
74 ( ItemDisplayType NUMBER -- 1=Calendar 2=task 3=memo 4=Calendar and task, 6= HR Calendar Events, 7=Schedules
75 , ItemSourceID NUMBER -- TASK_ID for task and appt
76 , ItemSourceCode VARCHAR2(30) -- For backward comptblty with Tasks Bins
77 , Source VARCHAR2(2000) -- source
78 , Customer VARCHAR2(2000) -- customer
79 , ItemName VARCHAR2(80) -- Display name of the item (prefix will be concatenated)
80 , AccessLevel NUMBER -- 0='anonymous block', 1='full access', 2='read access'
81 , AssignmentStatus NUMBER -- 1 for invite 0 for the rest
82 , InviteIndicator NUMBER -- 1 for invitations 0 for the rest
83 , RepeatIndicator NUMBER -- 1 for repeating appointments 0 for the rest
84 , RemindIndicator NUMBER -- 1 for reminders 0 for the rest
85 , StartDate DATE -- Start date for the item
86 , SourceObjectTypeCode VARCHAR2(60) -- source_object_type_code
87 , EndDate DATE -- End date for the item
88 , URL VARCHAR2(2000) -- filename
89 , URLParamList VARCHAR(2000)
90 , Attendees VARCHAR2(2000)
91 , Location VARCHAR2(4000)
92 , CustomerConfirmation CHAR(1)
93 , Status VARCHAR2(30)
94 , AssigneeStatus VARCHAR2(30)
95 , Priority VARCHAR2(30)
96 , TaskType VARCHAR2(30)
97 , Owner VARCHAR2(360)
98 , Description VARCHAR2(4000)
99 , GroupRSID NUMBER -- Resource ID of the group who owns the task
100 , FreeBusyType VARCHAR2(30)
101 , DisplayColor VARCHAR2(30)
102 );
103
104 /*******************************************************************************
105 ** PL/SQL table TYPE definition for the results of the GetView procedure
106 *******************************************************************************/
107 TYPE QueryOutTab IS TABLE OF QueryOut INDEX BY BINARY_INTEGER;
108
109 /**
110 * Given a ResourceID, this procedure will return a list of Calendars that the Calendar user has access to
111 * @param p_api_version API version number
112 * @param p_init_msg_list a flag to indicate if message list is initialized
113 * @param p_validation_level validation level (not used)
114 * @param x_return_status return status
115 * @param x_msg_count the number of message
116 * @param x_msg_data message data
117 * @param p_resourceID resource id
118 * @param p_resourceType resource type code
119 * @param p_userID user id
120 * @param x_calendarList a list of calendars
121 * @rep:displayname Get Calendar List
122 * @rep:lifecycle active
123 * @rep:compatibility N
124 */
125 PROCEDURE GetCalendarList
126 ( p_api_version IN NUMBER
127 , p_init_msg_list IN VARCHAR2 DEFAULT NULL
128 , p_validation_level IN NUMBER DEFAULT NULL
129 , x_return_status OUT NOCOPY VARCHAR2
130 , x_msg_count OUT NOCOPY NUMBER
131 , x_msg_data OUT NOCOPY VARCHAR2
132 , p_resourceID IN OUT NOCOPY NUMBER
133 , p_resourceType IN OUT NOCOPY VARCHAR2
134 , p_userID IN NUMBER
135 , x_calendarList OUT NOCOPY CalLstTblType
136 );
137
138 /**
139 * This procedure will return all task information needed to display the daily Calendar page
140 * @param p_api_version API version number
141 * @param p_init_msg_list a flag to indicate if message list is initialized
142 * @param p_validation_level validation level (not used)
143 * @param x_return_status return status
144 * @param x_msg_count the number of message
145 * @param x_msg_data message data
146 * @param p_input query criteria
147 * @param x_DisplayItems a list of calendar items queried
148 * @rep:displayname Get View
149 * @rep:lifecycle active
150 * @rep:compatibility N
151 */
152 PROCEDURE GetView
153 ( p_api_version IN NUMBER
154 , p_init_msg_list IN VARCHAR2 DEFAULT NULL
155 , p_validation_level IN NUMBER DEFAULT NULL
156 , x_return_status OUT NOCOPY VARCHAR2
157 , x_msg_count OUT NOCOPY NUMBER
158 , x_msg_data OUT NOCOPY VARCHAR2
159 , p_input IN CAC_VIEW_PVT.QueryIn
160 , x_DisplayItems OUT NOCOPY CAC_VIEW_PVT.QueryOutTab
161 );
162
163 /**
164 * This function will return the location associated with the given calendar
165 * @param p_task_id task id
166 * @rep:displayname Get Locations
167 * @rep:lifecycle active
168 * @rep:compatibility N
169 */
170 FUNCTION get_locations(p_task_id IN NUMBER)
171 RETURN VARCHAR2;
172
173 /**
174 * This function will return the calendar item type based on whether
175 * its begin and end date/time are defined. The type will determine
176 * where the calendar the item is shown: 1=Calendar 2=task 3=memo 5=split
177 * @param p_SourceCode source code
178 * @param p_PeriodStartDate period start date (not used)
179 * @param p_PeriodEndDate period end date (not used)
180 * @param p_StartDate calendar start date
181 * @param p_EndDate calendar end date
182 * @param p_CalSpanDaysProfile a flag to indicate if it spans across multiple days
183 * @return The item type number
184 * @rep:displayname Get Item Type
185 * @rep:lifecycle active
186 * @rep:compatibility N
187 */
188 FUNCTION GetItemType
189 ( p_SourceCode IN VARCHAR2
190 , p_PeriodStartDate IN DATE
191 , p_PeriodEndDate IN DATE
192 , p_StartDate IN DATE
193 , p_EndDate IN DATE
194 , p_CalSpanDaysProfile IN VARCHAR2
195 )RETURN NUMBER;
196
197 /**
198 * This function will return the contact name for the given party id and party type
199 * @param p_party_type_code Party Type
200 * @param p_party_id Party Id
201 * @rep:displayname Get Contact
202 * @rep:lifecycle active
203 * @rep:compatibility N
204 */
205 FUNCTION get_Contact(p_party_type_code in varchar2,p_party_id IN NUMBER)
206 RETURN VARCHAR2;
207
208 END; -- Package spec
[Home] [Help]