1 Package pqh_rule_attributes_api as
2 /* $Header: pqrlaapi.pkh 120.1 2005/10/02 02:27:26 aroussel $ */
3 /*#
4 * This package contains rule attribute APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Rule Attribute
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------------< insert_rule_attribute >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a rule attribute.
17 *
18 * The value defined for the attribute selected in the rule will be used for
19 * validating budget reallocation transaction attribute values. The API ensures
20 * that duplicate rule attributes are not saved for the same rule set,
21 * attribute, operation code and attribute values. It also ensures that number
22 * value is stored for attributes that are of number data type.
23 *
24 * <p><b>Licensing</b><br>
25 * This API is licensed for use with Human Resources.
26 *
27 * <p><b>Prerequisites</b><br>
28 * The attribute for which the rule is being defined must already exist. The
29 * valid list of operation codes must already be defined.
30 *
31 * <p><b>Post Success</b><br>
32 * The rule attribute is created successfully in the database.
33 *
34 * <p><b>Post Failure</b><br>
35 * The rule attribute is not created and an error is raised.
36 * @param p_rule_set_id Identifies the rule set under which the rule attribute
37 * is grouped.
38 * @param p_attribute_code Identifies the attribute for which the rule is
39 * defined.
40 * @param p_operation_code Identifies the operator to use for comparing the
41 * transaction attribute value to the attribute value defined in the rule.
42 * Valid values are defined by 'PQH_CBR_OPERATION_CODE' lookup type.
43 * @param p_attribute_value The value for the selected attribute.
44 * @param p_rule_attribute_id If p_validate is false, then this uniquely
45 * identifies the rule attribute created. If p_validate is true, then set to
46 * null.
47 * @param p_object_version_number If p_validate is false, then set to the
48 * version number of the created rule attribute. If p_validate is true, then
49 * the value will be null.
50 * @rep:displayname Create Rule Attribute
51 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_BUSINESS_RULE
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 * @rep:lifecycle active
55 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
56 */
57 --
58 -- {End Of Comments}
59 --
60 procedure Insert_Rule_Attribute
61 (p_rule_set_id in number
62 ,p_attribute_code in varchar2 default null
63 ,p_operation_code in varchar2 default null
64 ,p_attribute_value in varchar2 default null
65 ,p_rule_attribute_id out nocopy number
66 ,p_object_version_number out nocopy number);
67 --
68 -- ----------------------------------------------------------------------------
69 -- |--------------------------< update_rule_attribute >-----------------------|
70 -- ----------------------------------------------------------------------------
71 --
72 -- {Start Of Comments}
73 /*#
74 * This API updates a rule attribute.
75 *
76 * The API allows updating the value of the attribute for which the rule is
77 * defined. It ensures that duplicate rule attributes are not saved for the
78 * same rule set, attribute, operation code and attribute values. It also
79 * ensures that number value is stored for attributes that are of number data
80 * type.
81 *
82 * <p><b>Licensing</b><br>
83 * This API is licensed for use with Human Resources.
84 *
85 * <p><b>Prerequisites</b><br>
86 * The rule attribute that is to be updated must already exist. If the
87 * operation code is to be changed, then the valid list of operation codes must
88 * already be defined.
89 *
90 * <p><b>Post Success</b><br>
91 * The rule attribute is updated successfully in the database.
92 *
93 * <p><b>Post Failure</b><br>
94 * The rule attribute is not updated and an error is raised.
95 * @param p_rule_attribute_id Identifies uniquely the rule attribute to be
96 * modified.
97 * @param p_object_version_number Pass in the current version number of the
98 * rule attribute to be updated. When the API completes if p_validate is false,
99 * will be set to the new version number of the updated rule attribute. If
100 * p_validate is true will be set to the same value which was passed in.
101 * @param p_rule_set_id Identifies the rule set under which the rule attribute
102 * is grouped.
103 * @param p_attribute_code Identifies the attribute for which the rule is
104 * defined.
105 * @param p_operation_code Identifies the operator to use for comparing the
106 * transaction attribute value to the attribute value defined in the rule.
107 * Valid values are defined by 'PQH_CBR_OPERATION_CODE' lookup type.
108 * @param p_attribute_value The value for the selected attribute.
109 * @rep:displayname Update Rule Attribute
110 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_BUSINESS_RULE
111 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
112 * @rep:scope public
113 * @rep:lifecycle active
114 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
115 */
116 --
117 -- {End Of Comments}
118 --
119 procedure Update_Rule_Attribute
120 (p_rule_attribute_id in number
121 ,p_object_version_number in out nocopy number
122 ,p_rule_set_id in number default hr_api.g_number
123 ,p_attribute_code in varchar2 default hr_api.g_varchar2
124 ,p_operation_code in varchar2 default hr_api.g_varchar2
125 ,p_attribute_value in varchar2 default hr_api.g_varchar2
126 );
127 --
128 -- ----------------------------------------------------------------------------
129 -- |--------------------------< delete_rule_attribute >-----------------------|
130 -- ----------------------------------------------------------------------------
131 --
132 -- {Start Of Comments}
133 /*#
134 * This API deletes a rule attribute.
135 *
136 * Deleting the rule attribute removes the validation that must be performed
137 * for that attribute in a budget reallocation transaction.
138 *
139 * <p><b>Licensing</b><br>
140 * This API is licensed for use with Human Resources.
141 *
142 * <p><b>Prerequisites</b><br>
143 * The rule attribute which is to be deleted must already exist.
144 *
145 * <p><b>Post Success</b><br>
146 * The rule attribute is deleted successfully from the database.
147 *
148 * <p><b>Post Failure</b><br>
149 * The rule attribute is not deleted and an error is raised.
150 * @param p_rule_attribute_id Identifies uniquely the rule attribute to be
151 * deleted.
152 * @param p_object_version_number Current version number of the rule attribute
153 * to be deleted.
154 * @rep:displayname Delete Rule Attribute
155 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_BUSINESS_RULE
156 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
157 * @rep:scope public
158 * @rep:lifecycle active
159 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
160 */
161 --
162 -- {End Of Comments}
163 --
164 Procedure Delete_Rule_Attribute
165 (p_rule_attribute_id in number
166 ,p_object_version_number in number);
167 --
168 end PQH_RULE_ATTRIBUTES_API;
[Home] [Help]