1 PACKAGE FUN_RULE_CRITERIA_PUB AUTHID CURRENT_USER AS
2 /*$Header: FUNXTMRULRCTPUS.pls 120.1 2005/06/22 05:01:02 ammishra noship $ */
3 /*#
4 * This package contains the public APIs for Rules Criteria.
5 * @rep:scope internal
6 * @rep:product FUN
7 * @rep:displayname Rules Framework:Rules Criteria Definition
8 * @rep:category BUSINESS_ENTITY FUN_RULE_CRITERIA
9 * @rep:lifecycle active
10 */
11
12 --------------------------------------
13 -- declaration of record type
14 --------------------------------------
15
16 TYPE rule_criteria_rec_type IS RECORD (
17 criteria_id FUN_RULE_CRITERIA.CRITERIA_ID%TYPE,
18 rule_detail_id FUN_RULE_CRITERIA.RULE_DETAIL_ID%TYPE,
19 criteria_param_id FUN_RULE_CRITERIA.CRITERIA_PARAM_ID%TYPE,
20 condition FUN_RULE_CRITERIA.CONDITION%TYPE,
21 param_value FUN_RULE_CRITERIA.PARAM_VALUE%TYPE,
22 case_sensitive_flag FUN_RULE_CRITERIA.CASE_SENSITIVE_FLAG%TYPE,
23 creation_date FUN_RULE_CRITERIA.CREATION_DATE%TYPE,
24 created_by FUN_RULE_CRITERIA.CREATED_BY%TYPE,
25 last_update_date FUN_RULE_CRITERIA.LAST_UPDATE_DATE%TYPE,
26 last_updated_by FUN_RULE_CRITERIA.LAST_UPDATED_BY%TYPE,
27 last_update_login FUN_RULE_CRITERIA.LAST_UPDATE_LOGIN%TYPE,
28 created_by_module FUN_RULE_CRITERIA.CREATED_BY_MODULE%TYPE
29 );
30
31
32 --------------------------------------
33 -- declaration of public procedures and functions
34 --------------------------------------
35
36 /**
37 * PROCEDURE create_rule_criteria
38 *
39 * DESCRIPTION
40 * Creates criteria of each rule.
41 *
42 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
43 *
44 * ARGUMENTS
45 * IN:
46 * p_init_msg_list Initialize message stack if it is set to
47 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
48 * p_rule_criteria_rec Rule Criteria record.
49 * IN/OUT:
50 * OUT:
51 * x_return_status Return status after the call. The status can
52 * be FND_API.G_RET_STS_SUCCESS (success),
53 * FND_API.G_RET_STS_ERROR (error),
54 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
55 * x_msg_count Number of messages in message stack.
56 * x_msg_data Message text if x_msg_count is 1.
57 *
58 * NOTES
59 *
60 * MODIFICATION HISTORY
61 *
62 * 10-Sep-2004 Amulya Mishra Created.
63 *
64 */
65
66 /**
67 * Use this routine to create a rule criteria and its related information.
68 * With this API you can create a record in the FUN_RULE_CRITERIA table.
69 * By defining a criteria for rule end users can define their individual
70 * criteria parametere object name, condition, param value, case sensitive
71 * checking allowed or not etc.
72 * @rep:scope internal
73 * @rep:lifecycle active
74 * @rep:displayname Create Rule Criteria
75 * @rep:businessevent oracle.apps.fun.rules.server.HACustomizableObjectEO.create
76 * @rep:doccd
77 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
78 * @param p_rule_criteria_rec Rule Criteria record.
79 * @param x_criteria_id Internal identifier for the Rule Criteria
80 * @param x_return_status Return status after the call.
81 * @param x_msg_count Number of messages in message stack.
82 * @param x_msg_data Message text if x_msg_count is 1.
83 *
84 * @rep:comment 10-Sep-2004 Amulya Mishra Created
85
86 */
87
88 PROCEDURE create_rule_criteria(
89 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
90 p_rule_criteria_rec IN RULE_CRITERIA_REC_TYPE,
91 x_criteria_id OUT NOCOPY NUMBER,
92 x_return_status OUT NOCOPY VARCHAR2,
93 x_msg_count OUT NOCOPY NUMBER,
94 x_msg_data OUT NOCOPY VARCHAR2
95 );
96
97
98 /**
99 * Use this routine to update a Rule Criteria. The API updates records in the
100 * FUN_RULE_CRITERIA table.
101 * @rep:scope internal
102 * @rep:lifecycle active
103 * @rep:displayname Update Rule Criteria
104 * @rep:businessevent
105 * @rep:doccd
106 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
107 * @param p_rule_criteria_rec Rule Criteria record.
108 * @param p_object_version_number Record version number
109 * @param x_return_status Return status after the call.
110 * @param x_msg_count Number of messages in message stack.
111 * @param x_msg_data Message text if x_msg_count is 1.
112 *
113 * @rep:comment 10-Sep-2004 Amulya Mishra Created
114 */
115 PROCEDURE update_rule_criteria(
116 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
117 p_rule_criteria_rec IN RULE_CRITERIA_REC_TYPE,
118 p_object_version_number IN OUT NOCOPY NUMBER,
119 x_return_status OUT NOCOPY VARCHAR2,
120 x_msg_count OUT NOCOPY NUMBER,
121 x_msg_data OUT NOCOPY VARCHAR2
122 );
123
124
125 /**
126 * Use this routine to Get a Rule Criteria Record. The API selects record from the
127 * FUN_RULE_CRITERIA table.
128 *
129 * @rep:scope internal
130 * @rep:lifecycle active
131 * @rep:displayname Retrieve Rule Criteria Record
132 *
133 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
134 * @param p_criteria_id Internal Indentifier for the Criteria.
135 * @param p_rule_detail_id Internal identifier for the Rule.
136 * @param x_rule_criteria_rec Rule Criteria record.
137 * @param x_return_status Return status after the call.
138 * @param x_msg_count Number of messages in message stack.
139 * @param x_msg_data Message text if x_msg_count is 1.
140 *
141 * @rep:comment 10-Sep-2004 Amulya Mishra Created
142 */
143
144
145 PROCEDURE get_rule_criteria_rec (
146 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
147 p_criteria_id IN NUMBER,
148 p_rule_detail_id IN NUMBER,
149 x_rule_criteria_rec OUT NOCOPY RULE_CRITERIA_REC_TYPE,
150 x_return_status OUT NOCOPY VARCHAR2,
151 x_msg_count OUT NOCOPY NUMBER,
152 x_msg_data OUT NOCOPY VARCHAR2
153 );
154
155 /**
156 * Use this routine to delete a Rule Criteria. The API deletes records in the
157 * FUN_RULE_CRITERIA table.
158 *
159 * @rep:scope internal
160 * @rep:lifecycle active
161 * @rep:displayname Delete Rule Criteria
162 *
163 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
164 * @param p_criteria_id Internal Indentifier for the Criteria.
165 * @param x_return_status Return status after the call.
166 * @param x_msg_count Number of messages in message stack.
167 * @param x_msg_data Message text if x_msg_count is 1.
168 *
169 * @rep:comment 10-Sep-2004 Amulya Mishra Created
170 */
171
172 PROCEDURE delete_rule_criteria(
173 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
174 p_criteria_id IN NUMBER,
175 x_return_status OUT NOCOPY VARCHAR2,
176 x_msg_count OUT NOCOPY NUMBER,
177 x_msg_data OUT NOCOPY VARCHAR2
178 );
179
180 END FUN_RULE_CRITERIA_PUB;
[Home] [Help]