1 PACKAGE cn_mark_events_pub AS
2 /* $Header: cnpmkevs.pls 120.0 2006/08/25 00:19:00 ymao noship $ */
3 /*#
4 * This package provides the APIs for creating notification log records for incremental calculation.
5 * @rep:scope public
6 * @rep:product CN
7 * @rep:displayname Create Notification Log Records
8 * @rep:lifecycle active
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY CN_COMP_PLANS
11 */
12
13 -- Start of Comments
14 -- API name : Mark_Event_Calc
15 -- Type : Public.
16 -- Pre-reqs : None.
17 -- Usage : Used to create notification log records to re-compute commissions incrementally for the specified
18 -- salesrep within the given parameters
19 -- Desc : Procedure to create notification log records for the specified salesrep in the given time period
20 -- and optionally for the given plan element
21 -- Parameters :
22 -- IN p_api_version IN NUMBER Required
23 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API.G_FALSE
24 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
25 -- p_validation_level IN NUMBER Optional Default = FND_API.G_VALID_LEVEL_FULL
26 -- OUT x_return_status OUT VARCHAR2(1)
27 -- x_msg_count OUT NUMBER
28 -- x_msg_data OUT VARCHAR2(2000)
29 -- IN p_salesrep_id IN NUMBER
30 -- p_period_id IN NUMBER
31 -- p_start_date IN DATE Optional Default = NULL
32 -- p_end_date IN DATE Optional Default = NULL
33 -- p_quota_id IN NUMBER Optional Default = NULL
34 -- p_org_id IN NUMBER
35 -- Version : Current version 1.0
36 -- Initial version 1.0
37 --
38 -- Notes :
39 -- p_salesrep_id should be a valid salesrep identified in the operating unit specified by p_org_id.
40 -- p_period_id should specify the period for which calculation needs to be rerun
41 -- p_start_date should be within the period specified by p_period_id. It has a default value of null,
42 -- which is treated as the beginning of the specified period
43 -- p_end_date should be within the period specified by p_period_id. It has a default value of null,
44 -- which is treated as the end of the specified period
45 -- p_quota_id is the identifier of the plan element that needs to be recalculated. If it is null, all
46 -- plan elements of the specified salesrep will be calculated
47 -- p_org_id is the identifier of the operating unit
48 -- End of comments
49
50 /*#
51 * This procedure creates a new notification log record with the given specifications.
52 * @param p_api_version API version
53 * @param p_init_msg_list Initialize message list (default F)
54 * @param p_commit Commit flag (default F). If p_commit is not fnd_api.g_true, then the calculation will not be submitted even if all of the validations are successful.
55 * @param p_validation_level Validation level (default Full)
56 * @param x_return_status Return status
57 * @param x_msg_count Number of messages returned
58 * @param x_msg_data Contents of message if x_msg_count = 1
59 * @param p_salesrep_id Identifier of the salesrep for which notification log records will be created
60 * @param p_period_id Period for which calculation needs to be rerun.
61 * @param p_start_date Start date of the period for which calculation needs to be rerun. It should be within the specified period (default start of the period)
62 * @param p_end_date End date of the period for which calculation needs to be rerun. It should be within the specified period (default end of the period)
63 * @param p_quota_id Identifier of the plan element that needs to be recalculated. If it is null, all plan elements will be recalculated for the given period (default null)
64 * @param p_org_id Identifier of the operating unit
65 * @rep:scope public
66 * @rep:lifecycle active
67 * @rep:displayname Create Notification Log Records for Recalc
68 */
69
70 PROCEDURE Mark_Event_Calc
71 (p_api_version IN NUMBER,
72 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
73 p_commit IN VARCHAR2 := FND_API.G_FALSE,
74 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
75 x_return_status OUT NOCOPY VARCHAR2,
76 x_msg_count OUT NOCOPY NUMBER,
77 x_msg_data OUT NOCOPY VARCHAR2,
78 p_salesrep_id IN NUMBER,
79 p_period_id IN NUMBER,
80 p_start_date IN DATE := NULL,
81 p_end_date IN DATE := NULL,
82 p_quota_id IN NUMBER := NULL,
83 p_org_id IN NUMBER);
84
85 END cn_mark_events_pub;
[Home] [Help]