4 * This package is used to Create, Update and Delete the Context Usages
1 Package FF_FUNCTION_CONTEXT_USG_API AUTHID CURRENT_USER as
2 /* $Header: fffcuapi.pkh 120.2 2006/08/02 07:15:14 pgongada noship $ */
3 /*#
5 * to a Formula Function.
6 * @rep:scope public
7 * @rep:product pay
8 * @rep:displayname Context Usages For Formula Functions
9 */
10 -- ----------------------------------------------------------------------------
11 -- |------------------------------< create_context >--------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API is used to Create Context Usages to a specific Formula function.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is licensed for use with Oracle Payroll.
20 *
21 * <p><b>Prerequisites</b><br>
22 * The specified Formula Function should exist.
23 *
24 * <p><b>Post Success</b><br>
25 * A Context Usage to the specified Formula Function will be created and
26 * the out parameters will be set.
27 *
28 * <p><b>Post Failure</b><br>
29 * Context Usage to the specified Formula function will not be created
30 * and appropriate error message will be prompted.
31 *
32 * @param p_validate If true, then validation alone will be performed and the
33 * database will remain unchanged. If false and all validation checks pass,
34 * then the database will be modified.
35 * @param p_function_id Formula Function ID.
36 * @param p_context_id Formula Function Context.
37 * @param p_sequence_number Identifies Number for each parameter in a
38 * specific sequence.
39 * @param p_object_version_number If p_validate is false, then set to the
40 * version number of the created event procedure. If p_validate is true, then
41 * the value will be null.
42 * @rep:displayname Create Context Usage to a Formula Function
43 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
44 * @rep:lifecycle active
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
48 */
49 --
50 -- {End Of Comments}
51 --
52 --
53 procedure create_context
54 (p_validate in boolean default false
55 ,p_function_id in number
56 ,p_context_id in number
57 ,p_sequence_number out nocopy number
58 ,p_object_version_number out nocopy number
59 );
60 --
61 -- ----------------------------------------------------------------------------
62 -- |------------------------------< update_context >--------------------------|
63 -- ----------------------------------------------------------------------------
64 --
65 -- {Start Of Comments}
66 /*#
67 * This Business Process will be used to update Context Usages of a specific
68 * Formula function.
69 *
70 * <p><b>Licensing</b><br>
71 * This API is licensed for use with Oracle Payroll.
72 *
73 * <p><b>Prerequisites</b><br>
74 * The Context Usage of the specific Formula Function should exist.
75 *
76 * <p><b>Post Success</b><br>
77 * The Context Usage of the specified Formula will be successfully updated
78 * into the database and all the parameter will be set.
79 *
80 * <p><b>Post Failure</b><br>
81 * Error Messages will be raised if any business rule is violated and the
82 * specified Context Usage will not be updated.
83 *
84 * @param p_validate If true, then validation alone will be performed and the
85 * database will remain unchanged. If false and all validation checks pass,
86 * then the database will be modified.
87 * @param p_function_id Formula Function ID.
88 * @param p_sequence_number Identifies Number for each parameter in a
89 * specific sequence.
90 * @param p_object_version_number If p_validate is false, then set to the
91 * version number of the created event procedure. If p_validate is true, then
92 * the value will be null.
93 * @param p_context_id Formula Function Context.
94 * @rep:displayname Update Context Usage
95 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
96 * @rep:lifecycle active
97 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
98 * @rep:scope public
99 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
100 */
101 --
102 -- {End Of Comments}
103 --
104 procedure update_context
105 (p_validate in boolean default false
106 ,p_function_id in number
107 ,p_sequence_number in number
108 ,p_object_version_number in out nocopy number
109 ,p_context_id in number default hr_api.g_number
110 );
111 --
115 --
112 -- ----------------------------------------------------------------------------
113 -- |------------------------------< delete_context >--------------------------|
114 -- ----------------------------------------------------------------------------
116 -- {Start Of Comments}
117 /*#
118 * This Business Process will be used to delete Context Usage of a specific
119 * Formula function.
120 *
121 * <p><b>Licensing</b><br>
122 * This API is licensed for use with Oracle Payroll.
123 *
124 * <p><b>Prerequisites</b><br>
125 * The Context Usage of the specific Formula Function should exist.
126 *
127 * <p><b>Post Success</b><br>
128 * The Context Usage of the specified Formula Function will be
129 * successfully deleted from the database.
130 *
131 * <p><b>Post Failure</b><br>
132 * Error Messages are raised if any business rule is violated and the Formula
133 * Function Context Usage will not be deleted.
134 *
135 * @param p_validate If true, then validation alone will be performed and the
136 * database will remain unchanged. If false and all validation checks pass,
137 * then the database will be modified.
138 * @param p_function_id Formula Function ID.
139 * @param p_sequence_number Identifies Number for each parameter in a
140 * specific sequence.
141 * @param p_object_version_number If p_validate is false, then set to the
142 * version number of the created event procedure. If p_validate is true, then
143 * the value will be null.
144 *
145 * @rep:displayname Delete Context Usage
146 * @rep:category BUSINESS_ENTITY FF_FORMULA_FUNCTION
147 * @rep:lifecycle active
148 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
149 * @rep:scope public
150 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
151 */
152 --
153 -- {End Of Comments}
154 --
155
156 procedure delete_context
157 (p_validate in boolean default false
158 ,p_function_id in number
159 ,p_sequence_number in number
163 --
160 ,p_object_version_number in number
161 );
162
164 end FF_FUNCTION_CONTEXT_USG_API;
[Home] [Help]