[Home] [Help]
PACKAGE: APPS.OKC_API
Source
1 PACKAGE OKC_API AS
2 /* $Header: OKCPAPIS.pls 120.0 2005/05/25 22:50:34 appldev noship $ */
3 ------------------------------------------------------------------------------
4 -- GLOBAL STRUCTURES
5 ------------------------------------------------------------------------------
6 TYPE error_rec_type IS RECORD (
7 idx NUMBER,
8 error_type VARCHAR2(1),
9 msg_count INTEGER,
10 msg_data VARCHAR2(2000),
11 sqlcode NUMBER,
12 api_name VARCHAR2(30),
13 api_package VARCHAR2(30));
14 TYPE error_tbl_type IS TABLE OF error_rec_type
15 INDEX BY BINARY_INTEGER;
16
17 TYPE msg_rec_type IS RECORD (
18 error_status NUMBER,
19 data VARCHAR2(2000));
20 TYPE msg_tbl_type IS TABLE OF msg_rec_type
21 INDEX BY BINARY_INTEGER;
22 ------------------------------------------------------------------------------
23 -- GLOBAL CONSTANTS
24 ------------------------------------------------------------------------------
25 G_FALSE CONSTANT VARCHAR2(1) := FND_API.G_FALSE;
26 G_TRUE CONSTANT VARCHAR2(1) := FND_API.G_TRUE;
27 G_MISS_NUM CONSTANT NUMBER := FND_API.G_MISS_NUM;
28 G_MISS_CHAR CONSTANT VARCHAR2(1) := FND_API.G_MISS_CHAR;
29 G_MISS_DATE CONSTANT DATE := FND_API.G_MISS_DATE;
30 --------------------------------------------------------------------------------
31 -- GLOBAL MESSAGE CONSTANTS
32 --------------------------------------------------------------------------------
33 G_FND_APP CONSTANT VARCHAR2(200) := 'FND';
34 G_APP_NAME CONSTANT VARCHAR2(200) := 'OKC';
35 ---G_FORM_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := 'FORM_UNABLE_TO_RESERVE_RECORD';
36 G_FORM_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := 'FORM_COULD_NOT_RESERVE_RECORD';
37 G_FORM_RECORD_DELETED CONSTANT VARCHAR2(200) := 'OKC_RECORD_DELETED';
38 G_FORM_RECORD_CHANGED CONSTANT VARCHAR2(200) := 'OKC_RECORD_CHANGED';
39 G_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := 'FORM_COULD_NOT_RESERVE_RECORD';
40 G_RECORD_DELETED CONSTANT VARCHAR2(200) := 'OKC_RECORD_DELETED';
41 G_RECORD_CHANGED CONSTANT VARCHAR2(200) := 'OKC_RECORD_CHANGED';
42 G_RECORD_LOGICALLY_DELETED CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_RECORD_LDELETED';
43 G_REQUIRED_VALUE CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_REQUIRED_VALUE';
44 G_INVALID_VALUE CONSTANT VARCHAR2(200) := 'OKC_CONTRACTS_INVALID_VALUE';
45 G_COL_NAME_TOKEN CONSTANT VARCHAR2(200) := 'COL_NAME';
46 G_PARENT_TABLE_TOKEN CONSTANT VARCHAR2(200) := 'PARENT_TABLE';
47 G_CHILD_TABLE_TOKEN CONSTANT VARCHAR2(200) := 'CHILD_TABLE';
48 G_LOCK_RECORD_DELETED CONSTANT VARCHAR2(200) := 'OKC_LOCK_RECORD_DELETED';
49 --------------------------------------------------------------------------------
50 -- ERRORS AND EXCEPTIONS
51 --------------------------------------------------------------------------------
52 G_RET_STS_SUCCESS CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_SUCCESS;
53 G_RET_STS_WARNING CONSTANT VARCHAR2(1) := 'W';
54 G_RET_STS_ERROR CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_ERROR;
55 G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2(1) := FND_API.G_RET_STS_UNEXP_ERROR;
56 G_EXCEPTION_ERROR EXCEPTION;
57 G_EXCEPTION_UNEXPECTED_ERROR EXCEPTION;
58 G_EXC_WARNING EXCEPTION;
59 ---------------------------------------------------------------------------
60 -- VALIDATION LEVELS
61 ---------------------------------------------------------------------------
62 G_REQUIRED_VALUE_VALID_LEVEL CONSTANT NUMBER := 0;
63 G_VALID_VALUE_VALID_LEVEL CONSTANT NUMBER := 0;
64 G_LOOKUP_CODE_VALID_LEVEL CONSTANT NUMBER := 0;
65 G_FOREIGN_KEY_VALID_LEVEL CONSTANT NUMBER := 0;
66 G_RECORD_VALID_LEVEL CONSTANT NUMBER := 0;
67 ------------------------------------------------------------------------------
68 -- GLOBAL VARIABLES
69 ------------------------------------------------------------------------------
70 ------------------------------------------------------------------------------
71 -- Functions and Procedures
72 ------------------------------------------------------------------------------
73 PROCEDURE init_msg_list(
74 p_init_msg_list IN VARCHAR2);
75
76 FUNCTION start_activity(
77 p_api_name IN VARCHAR2,
78 p_pkg_name IN VARCHAR2,
79 p_init_msg_list IN VARCHAR2,
80 l_api_version IN NUMBER,
81 p_api_version IN NUMBER,
82 p_api_type IN VARCHAR2,
83 x_return_status OUT NOCOPY VARCHAR2
84 ) RETURN VARCHAR2;
85 FUNCTION start_activity(
86 p_api_name IN VARCHAR2,
87 p_init_msg_list IN VARCHAR2,
88 p_api_type IN VARCHAR2,
89 x_return_status OUT NOCOPY VARCHAR2
90 ) RETURN VARCHAR2;
91 FUNCTION handle_exceptions (
92 p_api_name IN VARCHAR2,
93 p_pkg_name IN VARCHAR2,
94 p_exc_name IN VARCHAR2,
95 x_msg_count OUT NOCOPY NUMBER,
96 x_msg_data OUT NOCOPY VARCHAR2,
97 p_api_type IN VARCHAR2
98 ) RETURN VARCHAR2;
99 PROCEDURE end_activity
100 (
101 x_msg_count OUT NOCOPY NUMBER,
102 x_msg_data OUT NOCOPY VARCHAR2
103 );
104
105 PROCEDURE set_message (
106 p_app_name IN VARCHAR2 DEFAULT OKC_API.G_APP_NAME,
107 p_msg_name IN VARCHAR2,
108 p_token1 IN VARCHAR2 DEFAULT NULL,
109 p_token1_value IN VARCHAR2 DEFAULT NULL,
110 p_token2 IN VARCHAR2 DEFAULT NULL,
111 p_token2_value IN VARCHAR2 DEFAULT NULL,
112 p_token3 IN VARCHAR2 DEFAULT NULL,
113 p_token3_value IN VARCHAR2 DEFAULT NULL,
114 p_token4 IN VARCHAR2 DEFAULT NULL,
115 p_token4_value IN VARCHAR2 DEFAULT NULL,
116 p_token5 IN VARCHAR2 DEFAULT NULL,
117 p_token5_value IN VARCHAR2 DEFAULT NULL,
118 p_token6 IN VARCHAR2 DEFAULT NULL,
119 p_token6_value IN VARCHAR2 DEFAULT NULL,
120 p_token7 IN VARCHAR2 DEFAULT NULL,
121 p_token7_value IN VARCHAR2 DEFAULT NULL,
122 p_token8 IN VARCHAR2 DEFAULT NULL,
123 p_token8_value IN VARCHAR2 DEFAULT NULL,
124 p_token9 IN VARCHAR2 DEFAULT NULL,
125 p_token9_value IN VARCHAR2 DEFAULT NULL,
126 p_token10 IN VARCHAR2 DEFAULT NULL,
127 p_token10_value IN VARCHAR2 DEFAULT NULL
128 );
129 END OKC_API;