1 PACKAGE FUN_RULE_DETAILS_PUB AUTHID CURRENT_USER AS
2 /*$Header: FUNXTMRULRDTPUS.pls 120.3 2006/10/05 04:57:22 havvari noship $ */
3 /*
4 * This package contains the public APIs for set of Rules.
5 * @rep:scope internal
6 * @rep:product FUN
7 * @rep:displayname Rules Framework:Set of Rules Defintion
8 * @rep:category BUSINESS_ENTITY FUN_rule_details
9 * @rep:lifecycle active
10 */
11
12 --------------------------------------
13 -- declaration of record type
14 --------------------------------------
15
16 TYPE rule_details_rec_type IS RECORD (
17 rule_detail_id FUN_RULE_DETAILS.RULE_DETAIL_ID%TYPE,
18 rule_object_id FUN_RULE_DETAILS.RULE_OBJECT_ID%TYPE,
19 rule_name FUN_RULE_DETAILS.RULE_NAME%TYPE,
20 seq FUN_RULE_DETAILS.SEQ%TYPE,
21 operator FUN_RULE_DETAILS.OPERATOR%TYPE,
22 enabled_flag FUN_RULE_DETAILS.ENABLED_FLAG%TYPE,
23 result_application_id FUN_RULE_DETAILS.RESULT_APPLICATION_ID%TYPE,
24 result_value FUN_RULE_DETAILS.RESULT_VALUE%TYPE,
25 creation_date FUN_RULE_DETAILS.CREATION_DATE%TYPE,
26 created_by FUN_RULE_DETAILS.CREATED_BY%TYPE,
27 last_update_date FUN_RULE_DETAILS.LAST_UPDATE_DATE%TYPE,
28 last_updated_by FUN_RULE_DETAILS.LAST_UPDATED_BY%TYPE,
29 last_update_login FUN_RULE_DETAILS.LAST_UPDATE_LOGIN%TYPE,
30 created_by_module FUN_RULE_DETAILS.CREATED_BY_MODULE%TYPE
31 );
32
33
34 --------------------------------------
35 -- declaration of public procedures and functions
36 --------------------------------------
37
38 /**
39 * Use this routine to create a rule and its related information.
40 * With this API you can create a record in the FUN_RULE_DETAILS table.
41 * @rep:scope internal
42 * @rep:lifecycle active
43 * @rep:displayname Create Rule
44 * @rep:businessevent oracle.apps.fun.rules.server.HACustomizableObjectEO.create
45 * @rep:doccd
46 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
47 * @param p_rule_detail_rec Rule record.
48 * @param x_rule_detail_id Internal identifier for the Rule
49 * @param x_return_status Return status after the call.
50 * @param x_msg_count Number of messages in message stack.
51 * @param x_msg_data Message text if x_msg_count is 1.
52 *
53 * @rep:comment 10-Sep-2004 Amulya Mishra Created
54 */
55
56 PROCEDURE create_rule_detail(
57 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
58 p_rule_detail_rec IN RULE_DETAILS_REC_TYPE,
59 x_rule_detail_id OUT NOCOPY NUMBER,
60 x_return_status OUT NOCOPY VARCHAR2,
61 x_msg_count OUT NOCOPY NUMBER,
62 x_msg_data OUT NOCOPY VARCHAR2
63 );
64
65 /**
66 * Use this routine to update a user defined rule. The API updates records in the
67 * FUN_RULE_DETAILS table.
68 * @rep:scope internal
69 * @rep:lifecycle active
70 * @rep:displayname Update User Defined Rule
71 * @rep:businessevent
72 * @rep:doccd
73 *
74 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
75 * @param p_rule_detail_rec Rule record.
76 * @param p_object_version_number Record version number
77 * @param x_return_status Return status after the call.
78 * @param x_msg_count Number of messages in message stack.
79 * @param x_msg_data Message text if x_msg_count is 1.
80 *
81 * @rep:comment 10-Sep-2004 Amulya Mishra Created
82 */
83 PROCEDURE update_rule_detail(
84 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
85 p_rule_detail_rec IN RULE_DETAILS_REC_TYPE,
86 p_object_version_number IN OUT NOCOPY NUMBER,
87 x_return_status OUT NOCOPY VARCHAR2,
88 x_msg_count OUT NOCOPY NUMBER,
89 x_msg_data OUT NOCOPY VARCHAR2
90 );
91
92 /**
93 * Gets Rule record.
94 *
95 * @rep:scope internal
96 * @rep:lifecycle active
97 * @rep:displayname Retrieve A Rule Record
98 *
99 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
100 * @param p_rule_detail_id Internal Identifier of Rule.
101 * @param p_rule_object_id Internal Identifier of Rule Object.
102 * @param x_rule_detail_rec Rule record.
103 * @param x_return_status Return status after the call.
104 * @param x_msg_count Number of messages in message stack.
105 * @param x_msg_data Message text if x_msg_count is 1.
106 *
107 * @rep:comment 10-Sep-2004 Amulya Mishra Created
108 */
109
110 PROCEDURE get_rule_detail_rec (
111 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
112 p_rule_detail_id IN NUMBER,
113 p_rule_object_id IN NUMBER,
114 x_rule_detail_rec OUT NOCOPY RULE_DETAILS_REC_TYPE,
115 x_return_status OUT NOCOPY VARCHAR2,
116 x_msg_count OUT NOCOPY NUMBER,
117 x_msg_data OUT NOCOPY VARCHAR2
118 );
119
120 /**
121 * Use this routine to delete a rule. The API deletes records in the
122 * FUN_RULE_DETAILS table.
123 *
124 * @rep:scope internal
125 * @rep:lifecycle active
126 * @rep:displayname Delete Rule.
127 *
128 * @param p_init_msg_list Initialize message stack if it is set to FND_API.G_TRUE. Default is FND_API.G_FALSE.
129 * @param p_rule_name Name of Rule
130 * @param p_rule_object_id Internal Identifier of Rule Object.
131 * @param x_return_status Return status after the call.
132 * @param x_msg_count Number of messages in message stack.
133 * @param x_msg_data Message text if x_msg_count is 1.
134 *
135 * @rep:comment 10-Sep-2004 Amulya Mishra Created
136 */
137
138 PROCEDURE delete_rule_detail(
139 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
140 p_rule_name IN VARCHAR2,
141 p_rule_object_id IN NUMBER,
142 x_return_status OUT NOCOPY VARCHAR2,
143 x_msg_count OUT NOCOPY NUMBER,
144 x_msg_data OUT NOCOPY VARCHAR2
145 );
146
147
148 END FUN_RULE_DETAILS_PUB;
[Home] [Help]