DBA Data[Home] [Help]

PACKAGE: APPS.PA_PROGRESS_CLIENT_EXTN

Source


1 PACKAGE PA_PROGRESS_CLIENT_EXTN AS
2 /* $Header: PAPCTCXS.pls 120.4 2006/06/23 13:40:04 dthakker noship $ */
3 /*#
4  * The client extension enables you to override the default method of deriving actual and estimated dates
5  * for tasks and task resources at any structure level.
6  * @rep:scope public
7  * @rep:product PA
8  * @rep:lifecycle active
9  * @rep:displayname Progress Management Extension
10  * @rep:compatibility S
11  * @rep:category BUSINESS_ENTITY PA_TASK
12  * @rep:category BUSINESS_ENTITY PA_TASK_RESOURCE
13  * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
14 */
15 
16 -- Procedure            : GET_TASK_RES_OVERRIDE_INFO
17 -- Type                 : Public Procedure
18 -- Purpose              : This API is to be used to override the default behaviour of Oracle Application
19 --                      : for deriving Actual and Estimated dates for lowest tasks and task assignments.
20 --                      : This API will be called for all lowest tasks and task assignments, while progress
21 --                      : entry and running summarization process. The three places it will be called from are
22 --                      : pa_progress_pub.update_task_progress, pa_assignment_progress_pub.update_assignment_progress
23 --                      : pa_progress_pub.get_summarized_actuals.
24 -- Note                 : The default behavior of this API will be to return the passed dates without any modifications.
25 -- Assumptions          : None.
26 -- Patching Instruction : Please do take backup of this package if any customizations are done. After patch application
27 --                      : , you need to apply this backed up package again.
28 
29 -- Parameters                   Type     Required        Description and Purpose
30 -- ---------------------------  ------   --------        --------------------------------------------------------
31 -- p_project_id                 NUMBER     NO            Unique key for the project.
32 -- p_structure_type             VARCHAR2   NO            Structure Type. Currently only WORKPLAN structure is supported.
33 --                                                       Possible values are WORKPLAN, FINANCIAL.
34 -- p_structure_version_id       NUMEBR     NO            Unique key for workplan structure version.
35 -- p_object_id                  NUMEBR     NO            Unique key for the object info. It is pa_proj_elements.proj_element_id for tasks
36 --                                                       and pa_resource_assignments.resource_list_member_id for task assignments.
37 -- p_object_type                VARCHAR2   NO            Possible values are 'PA_TASKS', 'PA_ASSIGNMENTS'
38 -- p_object_version_id          NUMEBR     NO            Unique key for the object version info. It is pa_proj_element_versions.element_version_id
39 --                                                       for tasks and task assignments both.
40 -- p_proj_element_id            NUMEBR     NO            Unique key for the task. It is pa_proj_elements.proj_element_id.
41 -- p_task_status                VARCHAR2   NO            Current status for the task. It is pa_percent_completes.status_code.
42 -- p_percent_complete           NUMEBR     NO            Physical percent complete. This is applicable for tasks only.
43 -- p_estimated_start_date       DATE       NO            Estimated start date for task and task assignments.
44 -- p_estimated_finish_date      DATE       NO            Estimated finish date for task and task assignments.
45 -- p_actual_start_date          DATE       NO            Actual start date for task and task assignments.
46 -- p_actual_finish_date         DATE       NO            Actual finish date for task and task assignments.
47 -- x_estimated_start_date       DATE       N/A            Returned Estimated start date for task and task assignments.
48 -- x_estimated_finish_date      DATE       N/A            Returned Estimated finish date for task and task assignments.
49 -- x_actual_start_date          DATE       N/A            Returned Actual start date for task and task assignments.
50 -- x_actual_finish_date         DATE       N/A            Returned Actual finish date for task and task assignments.
51 -- x_return_status              VARCHAR2   N/A            Return Status to identify if any issue in this API. Possible values
52 --                                                        are S for Success, E for Failure, U for Unexpected errors.
53 -- x_msg_count                  NUMBER     N/A            Count of the messages pushed into FND message stack.
54 -- x_msg_data                   VARCHAR2   N/A            Last message data from FND message stack if exists.
55 
56 
57 /*#
58  * This procedure is used to override the default method of deriving actual and estimated dates
59  * for tasks and task resources at any structure level.
60  * @param p_project_id Unique key for the project
61  * @param p_structure_type Structure Type of the structure. Possible values are WORKPLAN and FINANCIAL.
62  *  ( Currently only 'WORKPLAN' is supported )
63  * @param p_structure_version_id Unique key for the structure version
64  * @param p_object_type Type of the object being updated. Possible values are 'PA_TASKS' and 'PA_ASSIGNMENTS'.
65  * @param p_object_id Unique key for the object being updated. It is pa_proj_elements.proj_element_id for
66  * tasks and pa_resource_assignments.resource_list_member_id for task assignments.
67  * @param p_object_version_id Unique key for the object version info. It is pa_proj_element_versions.element_version_id
68  * for tasks and task assignments both.
69  * @param p_proj_element_id Unique key for the task. It is pa_proj_elements.proj_element_id.
70  * @param p_task_status Current status for the task. It is pa_percent_completes.status_code.
71  * @param p_percent_complete Physical percent complete for tasks only. This is applicable for tasks only.
72  * @param p_estimated_start_date Estimated start date
73  * @param p_estimated_finish_date Estimated finish date
74  * @param p_actual_start_date Actual start date
75  * @param p_actual_finish_date Actual finish date
76  * @param x_estimated_start_date Returned estimated start date
77  * @param x_estimated_finish_date Returned estimated finish date
78  * @param x_actual_start_date Returned actual start date
79  * @param x_actual_finish_date Returned actual finish date
80  * @param x_return_status Standard parameter API return status
81  * @param x_msg_count Standard parameter count of the messages
82  * @param x_msg_data Standard parameter last message data
83  * @rep:scope public
84  * @rep:lifecycle active
85  * @rep:displayname Override Task Progress Information
86  * @rep:compatibility S
87 */
88 PROCEDURE GET_TASK_RES_OVERRIDE_INFO(
89         p_project_id                    IN      NUMBER          := FND_API.g_miss_num   ,
90         p_structure_type                IN      VARCHAR2        := 'WORKPLAN'           ,
91         p_structure_version_id          IN      NUMBER          := FND_API.g_miss_num   ,
92         p_object_type                   IN      VARCHAR2        := FND_API.g_miss_char  ,
93         p_object_id                     IN      NUMBER          := FND_API.g_miss_num   ,
94         p_object_version_id             IN      NUMBER          := FND_API.g_miss_num   ,
95         p_proj_element_id               IN      NUMBER          := FND_API.g_miss_num   ,
96         p_task_status                   IN      VARCHAR2        := FND_API.g_miss_num   ,
97         p_percent_complete              IN      NUMBER          := FND_API.g_miss_num   ,
98         p_estimated_start_date          IN      DATE            := FND_API.g_miss_date  ,
99         p_estimated_finish_date         IN      DATE            := FND_API.g_miss_date  ,
100         p_actual_start_date             IN      DATE            := FND_API.g_miss_date  ,
101         p_actual_finish_date            IN      DATE            := FND_API.g_miss_date  ,
102         x_estimated_start_date          OUT     NOCOPY  DATE                            ,
103         x_estimated_finish_date         OUT     NOCOPY  DATE                            ,
104         x_actual_start_date             OUT     NOCOPY  DATE                            ,
105         x_actual_finish_date            OUT     NOCOPY  DATE                            ,
106         x_return_status                 OUT     NOCOPY  VARCHAR2                        ,
107         x_msg_count                     OUT     NOCOPY  NUMBER                          ,
108         x_msg_data                      OUT     NOCOPY  VARCHAR2
109         );
110 END;