[Home] [Help]
PACKAGE: APPS.OKL_API
Source
1 Package OKL_API AUTHID CURRENT_USER AS
2 /* $Header: OKLPAPIS.pls 120.2 2007/07/06 00:03:54 rmunjulu ship $ */
3
4 ------------------------------------------------------------------------------
5 -- GLOBAL STRUCTURES
6 ------------------------------------------------------------------------------
7 TYPE msg_rec_type IS RECORD (
8 error_status NUMBER,
9 data VARCHAR2(2000));
10 TYPE msg_tbl_type IS TABLE OF msg_rec_type
11 INDEX BY BINARY_INTEGER;
12
13 ------------------------------------------------------------------------------
14
15 -- GLOBAL STRUCTURES - Used by new TAPI generator (12/04/01)
16
17 ------------------------------------------------------------------------------
18
19 TYPE error_rec_type IS RECORD (
20 idx NUMBER,
21 error_type VARCHAR2(1),
22 msg_count INTEGER,
23 msg_data VARCHAR2(2000),
24 sqlcode NUMBER,
25 api_name VARCHAR2(30),
26 api_package VARCHAR2(30));
27 TYPE error_tbl_type IS TABLE OF error_rec_type
28 INDEX BY BINARY_INTEGER;
29
30 ------------------------------------------------------------------------------
31 -- GLOBAL CONSTANTS
32 ------------------------------------------------------------------------------
33 G_FALSE CONSTANT VARCHAR2(1) := FND_API.G_FALSE;
34 G_TRUE CONSTANT VARCHAR2(1) := FND_API.G_TRUE;
35 G_MISS_NUM CONSTANT NUMBER := FND_API.G_MISS_NUM;
36 G_MISS_CHAR CONSTANT VARCHAR2(1) := FND_API.G_MISS_CHAR;
37 G_MISS_DATE CONSTANT DATE := FND_API.G_MISS_DATE;
38 --------------------------------------------------------------------------------
39 -- GLOBAL MESSAGE CONSTANTS
40 --------------------------------------------------------------------------------
41 G_FND_APP CONSTANT VARCHAR2(200) := 'FND';
42 G_APP_NAME CONSTANT VARCHAR2(200) := 'OKL';
43 ---G_FORM_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := 'FORM_UNABLE_TO_RESERVE_RECORD';
44 G_FORM_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := 'FORM_COULD_NOT_RESERVE_RECORD';
45 G_FORM_RECORD_DELETED CONSTANT VARCHAR2(200) := 'FORM_RECORD_DELETED';
46 G_FORM_RECORD_CHANGED CONSTANT VARCHAR2(200) := 'FORM_RECORD_CHANGED';
47 G_RECORD_LOGICALLY_DELETED CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_RECORD_LDELETED';
48 G_REQUIRED_VALUE CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_REQUIRED_VALUE';
49 G_INVALID_VALUE CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_INVALID_VALUE';
50 G_COL_NAME_TOKEN CONSTANT VARCHAR2(200) := 'COL_NAME';
51 G_PARENT_TABLE_TOKEN CONSTANT VARCHAR2(200) := 'PARENT_TABLE';
52 G_CHILD_TABLE_TOKEN CONSTANT VARCHAR2(200) := 'CHILD_TABLE';
53 --------------------------------------------------------------------------------
54 -- ERRORS AND EXCEPTIONS
55 --------------------------------------------------------------------------------
56 G_RET_STS_SUCCESS CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_SUCCESS;
57 G_RET_STS_WARNING CONSTANT VARCHAR2(1) := 'W';
58 G_RET_STS_ERROR CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_ERROR;
59 G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_UNEXP_ERROR;
60 G_EXCEPTION_ERROR EXCEPTION;
61 G_EXCEPTION_UNEXPECTED_ERROR EXCEPTION;
62 G_EXC_WARNING EXCEPTION;
63 ------------------------------------------------------------------------------
64 -- GLOBAL VARIABLES
65 ------------------------------------------------------------------------------
66 ------------------------------------------------------------------------------
67 -- Functions and Procedures
68 ------------------------------------------------------------------------------
69 PROCEDURE init_msg_list(
70 p_init_msg_list IN VARCHAR2);
71 FUNCTION start_activity(
72 p_api_name IN VARCHAR2,
73 p_pkg_name IN VARCHAR2,
74 p_init_msg_list IN VARCHAR2,
75 l_api_version IN NUMBER,
76 p_api_version IN NUMBER,
77 p_api_type IN VARCHAR2,
78 x_return_status OUT NOCOPY VARCHAR2
79 ) RETURN VARCHAR2;
80 FUNCTION start_activity(
81 p_api_name IN VARCHAR2,
82 p_init_msg_list IN VARCHAR2,
83 p_api_type IN VARCHAR2,
84 x_return_status OUT NOCOPY VARCHAR2
85 ) RETURN VARCHAR2;
86 FUNCTION handle_exceptions (
87 p_api_name IN VARCHAR2,
88 p_pkg_name IN VARCHAR2,
89 p_exc_name IN VARCHAR2,
90 x_msg_count OUT NOCOPY NUMBER,
91 x_msg_data OUT NOCOPY VARCHAR2,
92 p_api_type IN VARCHAR2
93 ) RETURN VARCHAR2;
94 PROCEDURE end_activity
95 (
96 x_msg_count OUT NOCOPY NUMBER,
97 x_msg_data OUT NOCOPY VARCHAR2
98 );
99 PROCEDURE set_message (
100 p_app_name IN VARCHAR2 DEFAULT OKL_API.G_APP_NAME,
101 p_msg_name IN VARCHAR2,
102 p_token1 IN VARCHAR2 DEFAULT NULL,
103 p_token1_value IN VARCHAR2 DEFAULT NULL,
104 p_token2 IN VARCHAR2 DEFAULT NULL,
105 p_token2_value IN VARCHAR2 DEFAULT NULL,
106 p_token3 IN VARCHAR2 DEFAULT NULL,
107 p_token3_value IN VARCHAR2 DEFAULT NULL,
108 p_token4 IN VARCHAR2 DEFAULT NULL,
109 p_token4_value IN VARCHAR2 DEFAULT NULL,
110 p_token5 IN VARCHAR2 DEFAULT NULL,
111 p_token5_value IN VARCHAR2 DEFAULT NULL,
112 p_token6 IN VARCHAR2 DEFAULT NULL,
113 p_token6_value IN VARCHAR2 DEFAULT NULL,
114 p_token7 IN VARCHAR2 DEFAULT NULL,
115 p_token7_value IN VARCHAR2 DEFAULT NULL,
116 p_token8 IN VARCHAR2 DEFAULT NULL,
117 p_token8_value IN VARCHAR2 DEFAULT NULL,
118 p_token9 IN VARCHAR2 DEFAULT NULL,
119 p_token9_value IN VARCHAR2 DEFAULT NULL,
120 p_token10 IN VARCHAR2 DEFAULT NULL,
121 p_token10_value IN VARCHAR2 DEFAULT NULL
122 );
123
124 -- rmunjulu Added function which gets customer baseline
125 -- Returns H if customer coming from H to R12
126 -- Returns G if customer coming from G to R12
127 -- Returns a default of H if cannot find the lookup OKL_CUSTOMER_BASELINE
128 -- Returns NULL if ERROR
129 -- Pre-req - customer has to first apply OKLG or OKLH one-off which sets the baseline
130 FUNCTION get_customer_baseline RETURN VARCHAR2;
131
132 END OKL_API;