1 PACKAGE IGS_PERSONSTATS_PUB AS
2 /* $Header: IGSPAPSS.pls 120.0 2006/05/02 05:36:33 apadegal noship $ */
3
4 -- Start of comments
5 -- API name : REDERIVE_PERSONSTATS
6 -- Type : Public.
7 -- Function : To rederive the Person Statistics ( Inital and Most recent admittance terms, Catalog) for a person.
8 -- Pre-reqs : None.
9 -- Parameters :
10 -- IN : p_api_version :
11 -- It is Required parameter. Its data type is Number
12 -- p_init_msg_list :
13 -- It is an optional parameter.Default value is FND_API.G_FALSE
14 -- p_commit :
15 -- It is an optional parameter.Default value is FND_API.G_FALSE
16 -- p_validation_level :
17 -- It is an optional parameter.Default value is FND_API.G_VALID_LEVEL_FULL
18 -- p_person_id :
19 -- It is a Required/Optional parameter. Its data type is Number.
20 -- Maximum length is 15.Unique identifier assigned to the Applicant
21 -- p_group_id :
22 -- It is a Required/Optional parameter. Its data type is Number.
23 -- maximum length is 6. Unique identifier assigned to the Person Group
24 --
25 --
26 -- OUT : x_return_status :
27 -- It is out parameter that will contain the return status at the time of exiting the API.
28 -- and calling program can look into this variable to check whether API run was succesful or Not
29 -- It can have three values given below(with definition) :
30 -- G_RET_STS_SUCCESS CONSTANT VARCHAR2 (1):='S';
31 -- G_RET_STS_ERROR CONSTANT VARCHAR2 (1):='E';
32 -- G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2 (1):='U';
33 -- This variable is of type varchar2, and length should be 1
34 --
35 -- If the API is invoked with P_GROUP_ID, then this parameter would return SUCCESS only if all
36 -- the individual return statuses are SUCCESS [ Please refer parameter X_RETURN_STATUS_TBL for more details]
37 -- If
38 -- x_msg_count :
39 -- It is also a out variable which will hold total no of messages issued by API
40 -- This variable is of type number.
41 -- x_msg_data
42 -- if x_msg_count = 1 then this variable will hold the top message on message stack
43 -- else it will be null. Api will expect it as varchar2 type and length of 2000
44 --
45 -- x_return_status_tbl
46 -- It is an out parameter and should be used only if the API is invoked with P_GROUP_ID as parameter
47 -- Its data type is Return_Status_Tbl_Type, which is a Table of Record type Return_Status_Rec_Type.
48 --
49 -- Record type Return_Status_Rec_Type has got the following fields
50 --
51 -- Person_id
52 -- sub_return_status (like x_return_status)
53 -- sub_msg_count (like x_msg_count)
54 -- sub_msg_data (like x_msg_data)
55
56 -- The data type of the above fields would be same as their corresponding API parameters
57 -- The usage is also same, except that these values will be set for each of the person id in the person id group
58 --
59 -- The counter of table x_return_status_tbl would start with 1.
60 -- This table can be looped through 1 to x_return_status_tbl.count to get result of individual person ids
61 --
62 --
63 -- Note: 1. Atleast on parameter among p_person_id or p_group_id MUST BE passed
64 -- 2. If both parameters (P_PERSON_ID, P_GROUP_ID) are passed,
65 -- x_return_status will return
66 -- 2.1 G_RET_STS_UNEXP_ERROR --- if ATLEAST one of the individual person id's sub_return_status is G_RET_STS_UNEXP_ERROR
67 -- 2.2 G_RET_STS_ERROR --- if NONE one of the individual person id's sub_return_status is G_RET_STS_UNEXP_ERROR
68 -- and ALTEAST one of tHE individual person id's sub_return_status is G_RET_STS_ERROR
69 -- 2.3 G_RET_STS_SUCCESS --- ONLY if ALL of the individual person id's sub_return_status are G_RET_STS_SUCCESS
70 --
71
72 -- Version : Current version 1.0
73 -- Changed....
74 -- previous version N.A.
75 -- Initial version 1.0
76 -- Notes : Please note that atleast one parameter among P_PERSON_ID and P_GROUP_ID is mandatory.
77 -- End of comments
78
79
80
81 TYPE Return_Status_Rec_Type IS RECORD
82 ( Person_id NUMBER ,
83 sub_return_status VARCHAR2(1),
84 sub_msg_count NUMBER,
85 sub_msg_data VARCHAR2(32767)
86 );
87
88 TYPE Return_Status_Tbl_Type IS TABLE OF Return_Status_Rec_Type
89 INDEX BY BINARY_INTEGER;
90
91
92 PROCEDURE REDERIVE_PERSON_STATS(
93 --Standard Parameters Start
94 p_api_version IN NUMBER,
95 p_init_msg_list IN VARCHAR2 default FND_API.G_FALSE,
96 p_commit IN VARCHAR2 default FND_API.G_FALSE,
97 p_validation_level IN NUMBER default FND_API.G_VALID_LEVEL_FULL,
98 x_return_status OUT NOCOPY VARCHAR2,
99 x_msg_count OUT NOCOPY NUMBER,
100 x_msg_data OUT NOCOPY VARCHAR2,
101 --Standard parameter ends
102 p_person_id IN NUMBER,
103 p_group_id IN NUMBER,
104 x_return_status_tbl OUT NOCOPY Return_Status_Tbl_Type
105
106 );
107 END IGS_PERSONSTATS_PUB;
[Home] [Help]