DBA Data[Home] [Help]

PACKAGE: APPS.JTA_SYNC_TASK

Source


1 PACKAGE Jta_Sync_Task AUTHID CURRENT_USER AS
2 /* $Header: jtavstss.pls 115.36 2002/12/12 19:07:54 cjang ship $ */
3 /*=======================================================================+
4  |  Copyright (c) 2002 Oracle Corporation Redwood Shores, California, USA|
5  |                            All rights reserved.                       |
6  +=======================================================================+
7  | FILENAME                                                              |
8  |   jtavstss.pls                                                        |
9  |                                                                       |
10  | DESCRIPTION                                                           |
11  |   - This package contains top level API for syncing                   |
12  |           tasks(todos) and appointments.                              |
13  |                                                                       |
14  | NOTES                                                                 |
15  |                                                                       |
16  | Date          Developer        Change                                 |
17  | ------        ---------------  -------------------------------------- |
18  | 14-Jan-2002   mmarovic/arpatel Created.                               |
19  | 20-Jan-2002   sachoudh         Added recurrence into task_rec         |
20  | 22-Jan-2002   cjang            Refactoring                            |
21  | 11-Mar-2002   sanjeev          Changing methods for exclusions        |
22  | 15-Mar-2002   cjang            Changed the size of category to 40.    |
23  | 01-May-2002   cjang            Changed the size of subject to 2000.   |
24  | 16-May-2002   sachoudh         Changed the size of category to 140.   |
25  | 24-Jun-2002   cjang            Fix Bug 2418798:                       |
26  |                                Changed the size of category to 255.   |
27  +======================================================================*/
28 
29    G_LOGIN_RESOURCE_ID NUMBER;
30 
31 
32 TYPE task_rec IS RECORD (
33    syncId              NUMBER         -- The unique sync ID
34   ,recordIndex         NUMBER       := Fnd_Api.G_MISS_num     -- Index equal to the relative record
35   ,task_id       NUMBER
36                       -- number of record set starting at 0.
37   ,syncAnchor          DATE          -- sync anchor date
38   ,timeZoneId          NUMBER := 0       -- Default time zone is GMT
39   ,eventType           VARCHAR2(30)       --'New', 'Delete', 'Modify'
40 
41   -- Task common fields
42   ,objectCode          VARCHAR2(30)   -- Type: 'TASK' or 'APPOINTMENT'
43   ,subject             VARCHAR2(2000)  := Fnd_Api.G_MISS_char -- Subject/name field
44   ,description         VARCHAR2(4000) := Fnd_Api.G_MISS_char -- Description
45   ,dateSelected        VARCHAR2(1) := Fnd_Api.G_MISS_char
46   ,plannedStartDate    DATE       := Fnd_Api.G_MISS_date -- Start date
47   ,plannedEndDate      DATE       := Fnd_Api.G_MISS_date -- End/Completed date
48   ,scheduledStartDate  DATE       := Fnd_Api.G_MISS_date -- Start date
49   ,scheduledEndDate    DATE       := Fnd_Api.G_MISS_date -- End/Completed date
50   ,actualStartDate     DATE       := Fnd_Api.G_MISS_date -- Start date
51   ,actualEndDate       DATE       := Fnd_Api.G_MISS_date -- End/Completed date
52   ,statusId            NUMBER     := Fnd_Api.G_MISS_num  -- Task status
53   ,priorityId          NUMBER     := Fnd_Api.G_MISS_num  -- Task priority (0-99)
54   ,alarmFlag           VARCHAR2(1)    := Fnd_Api.G_MISS_char -- Task alarm flag (Y/N)
55   ,alarmDate           DATE       := Fnd_Api.G_MISS_date -- Alarm trigger date
56   ,privateFlag         VARCHAR2(1)    := Fnd_Api.G_MISS_char -- Private flag (Y/N)
57   ,category            VARCHAR2(255)  := Fnd_Api.G_MISS_char -- Task category name
58   ,resourceId          NUMBER   := Fnd_Api.G_MISS_num
59   ,resourceType        VARCHAR2(2000)  := Fnd_Api.G_MISS_char
60   ,task_assignment_id  NUMBER
61   ,resultId            NUMBER(1)      -- Result Identifier:
62                        -- 0 Success, no message will be displayed
63                        -- 1 Success, message will be displayed
64                        -- 2 Soft Failure, msg will be displayed
65                        --   and sync process will continue
66                        -- 3 Hard Failure, msg will be displayed
67                        --   and sync process will terminate
68   ,resultSystemMessage VARCHAR2(255)  -- System message (API message code)
69   ,resultUserMessage   VARCHAR2(2000) -- Valid and Meaningful message to the usr
70 
71   -- fields added for recurring tasks
72   ,unit_of_measure     VARCHAR2(30)      := Fnd_Api.G_MISS_char   -- unit of measure MON , DAY  , WEEK etc
73   ,occurs_every        NUMBER        := Fnd_Api.G_MISS_num    --occurs every month/day/week
74   --,occurs_number       NUMBER        := Fnd_Api.G_MISS_num    --occurs number
75   ,start_date          DATE          := Fnd_Api.G_MISS_date -- start date
76   ,end_date            DATE          := Fnd_Api.G_MISS_date -- end date
77   ,sunday              VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
78   ,monday              VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
79   ,tuesday              VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
80   ,wednesday           VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
81   ,thursday            VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
82   ,friday              VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
83   ,saturday            VARCHAR2(1)       := Fnd_Api.G_MISS_char -- flag (Y/N)
84   ,date_of_month       NUMBER        := Fnd_Api.G_MISS_num    --date of month
85   ,occurs_which        NUMBER        := Fnd_Api.G_MISS_num    --date of month
86 );
87 TYPE exclusion_rec IS RECORD (
88    syncId              NUMBER         -- The unique sync ID
89   ,exclusion_date      DATE          := Fnd_Api.G_MISS_date -- exclusion date
90 );
91 -- The task_tbl is table of task_rec type
92 TYPE task_tbl IS TABLE OF task_rec
93           INDEX BY BINARY_INTEGER;
94 -- The exclusion_tbl is table of reclusion_rec type
95 TYPE exclusion_tbl IS TABLE OF exclusion_rec
96           INDEX BY BINARY_INTEGER;
97 
98 --------------------------------------------------------------------------
99 --  API name    : get_count_appt
100 --  Type    : Public
101 --  Function    : Gets count of new/modified/deleted records after last sync date
102 --  Notes:  :
103 --------------------------------------------------------------------------
104 PROCEDURE get_count (
105       p_request_type     IN VARCHAR2 -- Input: Request Type - APPOINTMENTS/TASKS
106      ,p_syncAnchor       IN DATE     -- Input: current sync date,
107      ,x_total           OUT NOCOPY NUMBER
108      ,x_totalNew        OUT NOCOPY NUMBER
109      ,x_totalModified   OUT NOCOPY NUMBER
110      ,x_totalDeleted    OUT NOCOPY NUMBER
111    );
112 
113 --------------------------------------------------------------------------
114 --  API name    : get_list
115 --  Type    : Public
116 --  Function    : Gets list of appointments/tasks since last sync date between start and
117 --        end record indexes (provided by intellisync).
118 --  Notes:  :
119 --------------------------------------------------------------------------
120    PROCEDURE get_list (
121       p_request_type   IN VARCHAR2 -- Input: Request Type - APPOINTMENT/TASK
122      ,p_syncAnchor     IN DATE     -- Input: current sync date,
123      ,x_data          OUT NOCOPY Jta_Sync_Task.task_tbl
124      ,x_exclusion_data     OUT NOCOPY Jta_Sync_Task.exclusion_tbl
125    );
126 
127 --------------------------------------------------------------------------
128 --  API name    : create_ids
129 --  Type    : Private
130 --  Function    : Create requested number of IDs using sequence.
131 --  Notes:
132 --------------------------------------------------------------------------
133 PROCEDURE create_ids (
134       p_num_req IN     NUMBER,
135       x_results IN OUT NOCOPY Jta_Sync_Task.task_tbl
136    );
137 
138 --------------------------------------------------------------------------
139 --  API name    : update_data
140 --  Type    : Private
141 --  Function    : Update (create or modify) task data sent by sync engine.
142 --  Notes:
143 --------------------------------------------------------------------------
144  PROCEDURE update_data (p_tasks IN OUT NOCOPY Jta_Sync_Task.task_tbl,p_exclusions IN Jta_Sync_Task.exclusion_tbl);
145 
146 --------------------------------------------------------------------------
147 --  API name    : delete_data
148 --  Type    : Private
149 --  Function    : Delete tasks indicated by sync engine.
150 --  Notes:
151 --------------------------------------------------------------------------
152 PROCEDURE delete_data (p_tasks IN OUT NOCOPY Jta_Sync_Task.task_tbl);
153 
154 END Jta_Sync_Task;