[Home] [Help]
PACKAGE: APPS.OKL_RULE_EXTRACT_PUB
Source
1 Package OKL_RULE_EXTRACT_PUB AS
2 /* $Header: OKLPREXS.pls 120.6 2008/02/29 10:49:34 asawanka ship $ */
3 /*#
4 *Contract Rules API allows users to query terms and conditions
5 *related to data for a lease contract using calls to PL/SQL functions.
6 * @rep:scope public
7 * @rep:product OKL
8 * @rep:displayname Contract Rules API
9 * @rep:category BUSINESS_ENTITY OKL_ORIGINATION
10 * @rep:lifecycle active
11 * @rep:compatibility S
12 */
13
14 ---------------------------------------------------------------------------
15 -- GLOBAL MESSAGE CONSTANTS
16 ---------------------------------------------------------------------------
17 G_FND_APP CONSTANT VARCHAR2(200) := OKL_API.G_FND_APP;
18 G_FORM_UNABLE_TO_RESERVE_REC CONSTANT VARCHAR2(200) := OKL_API.G_FORM_UNABLE_TO_RESERVE_REC;
19 G_FORM_RECORD_DELETED CONSTANT VARCHAR2(200) := OKL_API.G_FORM_RECORD_DELETED;
20 G_FORM_RECORD_CHANGED CONSTANT VARCHAR2(200) := OKL_API.G_FORM_RECORD_CHANGED;
21 G_RECORD_LOGICALLY_DELETED CONSTANT VARCHAR2(200) := OKL_API.G_RECORD_LOGICALLY_DELETED;
22 G_REQUIRED_VALUE CONSTANT VARCHAR2(200) := OKL_API.G_REQUIRED_VALUE;
23 G_INVALID_VALUE CONSTANT VARCHAR2(200) := OKL_API.G_INVALID_VALUE;
24 G_COL_NAME_TOKEN CONSTANT VARCHAR2(200) := OKL_API.G_COL_NAME_TOKEN;
25 G_PARENT_TABLE_TOKEN CONSTANT VARCHAR2(200) := OKL_API.G_PARENT_TABLE_TOKEN;
26 G_CHILD_TABLE_TOKEN CONSTANT VARCHAR2(200) := OKL_API.G_CHILD_TABLE_TOKEN;
27 G_ERROR CONSTANT VARCHAR2(30) := 'OKL_CONTRACTS_ERROR';
28 G_UNEXPECTED_ERROR CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_UNEXP_ERROR';
29 G_SQLERRM_TOKEN CONSTANT VARCHAR2(200) := 'SQLerrm';
30 G_SQLCODE_TOKEN CONSTANT VARCHAR2(200) := 'SQLcode';
31 G_UPPERCASE_REQUIRED CONSTANT VARCHAR2(200) := 'OKL_CONTRACTS_UPPERCASE_REQ';
32 ------------------------------------------------------------------------------------
33 -- GLOBAL EXCEPTION
34 ---------------------------------------------------------------------------
35 G_EXCEPTION_HALT_VALIDATION EXCEPTION;
36 G_API_TYPE CONSTANT VARCHAR2(4) := '_PUB';
37 G_API_VERSION CONSTANT NUMBER := 1.0;
38 G_SCOPE CONSTANT VARCHAR2(4) := '_PUB';
39 -- GLOBAL VARIABLES
40 ---------------------------------------------------------------------------
41 G_PKG_NAME CONSTANT VARCHAR2(200) := 'OKL_RULE_EXTRACT_PUB';
42 G_APP_NAME CONSTANT VARCHAR2(3) := OKL_API.G_APP_NAME;
43 ---------------------------------------------------------------------------
44 --structures to hold rule code records
45 SUBTYPE rule_rec_type is OKL_RULE_EXTRACT_PVT.rule_rec_type;
46 SUBTYPE rule_tbl_type is OKL_RULE_EXTRACT_PVT.rule_tbl_type;
47 --structures to hold subclass-rulegroup records
48 SUBTYPE sc_rg_rec_type is OKL_RULE_EXTRACT_PVT.sc_rg_rec_type;
49 SUBTYPE sc_rg_tbl_type is OKL_RULE_EXTRACT_PVT.sc_rg_tbl_type;
50 --structures to hold rule group - rules records
51 SUBTYPE rg_rules_rec_type is OKL_RULE_EXTRACT_PVT.rg_rules_rec_type;
52 SUBTYPE rg_rules_tbl_type is OKL_RULE_EXTRACT_PVT.rg_rules_tbl_type;
53 --structures to hold rule-segment records
54 --this will hold the retreived metadata for rendering of
55 --rule segments
56 SUBTYPE rul_segment_rec_type is OKL_RULE_EXTRACT_PVT.rul_segment_rec_type;
57 SUBTYPE rule_segment_tbl_type is OKL_RULE_EXTRACT_PVT.rule_segment_tbl_type;
58 -- bug 3029276.
59 --structures to hold rule-segment records
60 --this will hold the retreived metadata for rendering of
61 --rule segments and also to hold ids and names for each segment.
62 SUBTYPE rule_segment_rec_type2 is OKL_RULE_EXTRACT_PVT.rule_segment_rec_type2;
63 SUBTYPE rule_segment_tbl_type2 is OKL_RULE_EXTRACT_PVT.rule_segment_tbl_type2;
64
65 --start of comments
66 --API Name : Get_Subclass_Rgs
67 --Description :API to fetch all the rule groups attached to a subclass
68 --end of comments
69 /*#
70 * Get subclass rule groups.
71 * @param p_api_version API version
72 * @param p_init_msg_list Initialize message stack
73 * @param x_return_status Return status from the API
74 * @param x_msg_count Message count if error messages are encountered
75 * @param x_msg_data Error message data
76 * @param p_chr_id Contract identifier
77 * @param x_sc_rg_tbl Subclass rule groups table
78 * @rep:displayname Get Subclass Rule Groups
79 * @rep:scope public
80 * @rep:lifecycle active
81 * @rep:category BUSINESS_ENTITY OKL_ORIGINATION
82 */
83 PROCEDURE Get_subclass_Rgs (p_api_version IN NUMBER,
84 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
85 x_return_status OUT NOCOPY VARCHAR2,
86 x_msg_count OUT NOCOPY NUMBER,
87 x_msg_data OUT NOCOPY VARCHAR2,
88 p_chr_id IN Varchar2,
89 x_sc_rg_tbl OUT NOCOPY sc_rg_tbl_type);
90 --start of comments
91 --API Name : Get_Rg_Rules
92 --Description : API to fetch all the rules attached to a rule group
93 --end of comments
94 /*#
95 * Get rule group rules.
96 * @param p_api_version API version
97 * @param p_init_msg_list Initialize message stack
98 * @param x_return_status Return status from the API
99 * @param x_msg_count Message count if error messages are encountered
100 * @param x_msg_data Error message data
101 * @param p_rgd_code Rule group code
102 * @param x_rg_rules_tbl Rule records table
103 * @rep:displayname Get Rule Group Rules
104 * @rep:scope public
105 * @rep:lifecycle active
106 * @rep:category BUSINESS_ENTITY OKL_ORIGINATION
107 */
108 PROCEDURE Get_Rg_Rules (p_api_version IN NUMBER,
109 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
110 x_return_status OUT NOCOPY VARCHAR2,
111 x_msg_count OUT NOCOPY NUMBER,
112 x_msg_data OUT NOCOPY VARCHAR2,
113 p_rgd_code IN Varchar2,
114 x_rg_rules_tbl OUT NOCOPY rg_rules_tbl_type);
115 --start of comments
116 --API Name : Get_Rule_Def
117 --Description : API to fetch rule definition - metadata for each rule segment
118 --end of comments
119 /*#
120 * Get rule group rules.
121 * @param p_api_version API version
122 * @param p_init_msg_list Initialize message stack
123 * @param x_return_status Return status from the API
124 * @param x_msg_count Message count if error messages are encountered
125 * @param x_msg_data Error message data
126 * @param p_rgd_code Rule group code
127 * @param p_rgs_code Rule code
128 * @param p_buy_or_sell Contract intent
129 * @param x_rule_segment_tbl Rule segment table
130 * @rep:displayname Get Rule Group Rules
131 * @rep:scope public
132 * @rep:lifecycle active
133 * @rep:category BUSINESS_ENTITY OKL_ORIGINATION
134 */
135 PROCEDURE Get_Rule_Def (p_api_version IN NUMBER,
136 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
137 x_return_status OUT NOCOPY VARCHAR2,
138 x_msg_count OUT NOCOPY NUMBER,
139 x_msg_data OUT NOCOPY VARCHAR2,
140 p_rgd_code IN VARCHAR2,
141 p_rgs_code IN VARCHAR2,
142 p_buy_or_sell IN VARCHAR2,
143 x_rule_segment_tbl OUT NOCOPY rule_segment_tbl_type);
144
145
146 -- bug 3029276
147 --start of comments
148 --API Name : Get_Rules_Metadata
149 --Description : API to fetch rule definition - metadata for each rule segment
150 -- and retrieve ids and names for each segment.
151 --end of comments
152
153 PROCEDURE Get_Rules_Metadata (p_api_version IN NUMBER,
154 p_init_msg_list IN VARCHAR2 DEFAULT OKL_API.G_FALSE,
155 x_return_status OUT NOCOPY VARCHAR2,
156 x_msg_count OUT NOCOPY NUMBER,
157 x_msg_data OUT NOCOPY VARCHAR2,
158 p_rgd_code IN VARCHAR2,
159 p_rgs_code IN VARCHAR2,
160 p_buy_or_sell IN VARCHAR2,
161 p_contract_id IN OKC_K_HEADERS_B.ID%TYPE := OKC_API.G_MISS_NUM,
162 p_line_id IN OKC_K_LINES_B.ID%TYPE := OKC_API.G_MISS_NUM,
163 p_party_id IN OKC_K_PARTY_ROLES_B.ID%TYPE := OKC_API.G_MISS_NUM,
164 p_template_table IN VARCHAR2,
165 p_rule_id_column IN VARCHAR2,
166 p_entity_column IN VARCHAR2,
167 x_rule_segment_tbl OUT NOCOPY rule_segment_tbl_type2);
168
169 ---------- -- end bug 3029276
170
171
172
173 End OKL_RULE_EXTRACT_PUB;