1 Package PAY_BALANCE_FEEDS_API as
2 /* $Header: pypbfapi.pkh 120.0.12010000.1 2008/07/27 23:20:58 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_balance_feed >--------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- Creates a balance feed
11 --
12 -- Prerequisites:
13 --
14 --
15 -- In Parameters:
16 -- Name Reqd Type Description
17 -- P_VALIDATE N Boolean If true database remains
18 -- unchanged. If false then
19 -- balance feed will be
20 -- created in the database.
21 -- P_EFFECTIVE_DATE Y Date
22 -- P_BUSINESS_GROUP_ID N Number
23 -- P_LEGISLATION_CODE N varchar2
24 -- P_BALANCE_TYPE_ID Y Number Balance type identifier
25 -- P_INPUT_VALUE_ID Y Number Input value identifier
26 -- P_SCALE Y Varchar2
27 -- P_LEGISLATION_SUBGROUP N varchar2
28 -- P_INITIAL_FEED N BOOLEAN This parameter is obsolete
29 -- and no longer used.
30 -- The value will be derived
31 -- from input value.
32 --
33 -- Post Success:
34 -- When the balance feed is created the following out parameters are set
35 --
36 -- Name Type Description
37 -- P_BALANCE_FEED_ID NUMBER If p_validate is false, this
38 -- uniquely identifies the balance
39 -- attribute default created.
40 -- If p_validate is set to true,
41 -- this parameter will be null.
42 -- P_EFFECTIVE_START_DATE DATE Effective Start Date
43 -- If p_validate is set to true this
44 -- will be set to NULL
45 -- P_EFFECTIVE_END_DATE DATE Effective End Date
46 -- If p_validate is set to true this
47 -- will be set to NULL
48 -- P_OBJECT_VERSION_NUMBER NUMBER Object Version Number
49 -- If p_validate is set to true this
50 -- will be set to NULL
51 -- P_EXIST_RUN_RESULT_WARNING BOOLEAN Will be set to TRUE if processed
52 -- run results exist
53 -- Post Failure:
54 -- Error Messages are raised if any business rule is violated and the balance
55 -- feed is not created
56 --
57 -- Access Status:
58 -- Public
59 --
60 -- {End Of Comments}
61 --
62 procedure create_balance_feed
63 (p_validate in boolean default false
64 ,p_effective_date in date
65 ,p_balance_type_id in number
66 ,p_input_value_id in number
67 ,p_scale in varchar2
68 ,p_business_group_id in number default null
69 ,p_legislation_code in varchar2 default null
70 ,p_legislation_subgroup in varchar2 default null
71 ,p_initial_feed in boolean default false
72 ,p_balance_feed_id out nocopy number
73 ,p_effective_start_date out nocopy date
74 ,p_effective_end_date out nocopy date
75 ,p_object_version_number out nocopy number
76 ,p_exist_run_result_warning out nocopy boolean
77 );
78 --
79 --
80 -- ----------------------------------------------------------------------------
81 -- |--------------------------< update_balance_feed >--------------------------|
82 -- ----------------------------------------------------------------------------
83 -- {Start Of Comments}
84 --
85 -- Description:
86 -- This API is used to update a balance feed as of the effective date
87 --
88 -- Prerequisites:
89 -- A Balance Feed for a balance must be setup.
90 --
91 -- In Parameters:
92 -- Name Reqd Type Description
93 -- P_VALIDATE N Boolean If true database remains
94 -- unchanged. If false then
95 -- balance feed will be
96 -- updated in the database.
97 -- P_EFFECTIVE_DATE Y Date Effective start date for the
98 -- balance feed
99 -- P_DATETRACK_UPDATE_MODE Y varchar2 Update Mode
100 -- P_BALANCE_FEED_ID Y Number Id of the Balance feed being
101 -- updated
102 -- P_SCALE N Varchar2 Scale value for the feed being
103 -- updated
104 --
105 -- Post Success:
106 -- When the balance feed is updated the following out parameters are set
107 ---- Name Type Description
108 -- P_EFFECTIVE_START_DATE DATE Effective Start Date
109 -- If p_validate is set to true this
110 -- will be set to NULL
111 -- P_EFFECTIVE_END_DATE DATE Effective End Date
112 -- If p_validate is set to true this
113 -- will be set to NULL
114 -- P_OBJECT_VERSION_NUMBER NUMBER Object Version Number
115 -- If p_validate is set to true this
116 -- will be set to NULL
117 -- P_EXIST_RUN_RESULT_WARNING BOOLEAN Will be set to TRUE if processed
118 -- run results exist
119 -- Post Failure:
120 -- Error Messages are raised if any business rule is violated and the balance
121 -- feed is not updated.
122 --
123 -- Access Status:
124 -- Public
125 --
126 -- {End Of Comments}
127 --
128 procedure update_balance_feed
129 (p_validate in boolean default false
130 ,p_effective_date in date
131 ,p_datetrack_update_mode in varchar2
132 ,p_balance_feed_id in number
133 ,p_scale in varchar2 default hr_api.g_number
134 ,p_object_version_number in out nocopy number
135 ,p_effective_start_date out nocopy date
136 ,p_effective_end_date out nocopy date
137 ,p_exist_run_result_warning out nocopy boolean
138 );
139 --
140 --
141 -- ----------------------------------------------------------------------------
142 -- |--------------------------< delete_balance_feed >-------------------------|
143 -- ----------------------------------------------------------------------------
144 -- {Start Of Comments}
145 --
146 -- Description:
147 -- This API is used to Delete a balance feed as identified by p_balance_feed_id
148 -- and p_object_version_number
149 -- The delete operation depends on the datetrack mode being selected.
150 --
151 -- Prerequisites:
152 -- The balance feed as identified by the in parameter p_balance_feed_id must
153 -- already exist.
154 --
155 -- In Parameters:
156 -- Name Reqd Type Description
157 -- p_validate Y boolean If true, then the database
158 -- remains unchanged. If false
159 -- then the balance feed will
160 -- be deleted.
161 -- p_effective_date Y date Effective start date for the
162 -- balance feed
163 -- p_datetrack_delete_mode Y varchar2 Delete mode.
164 -- p_balance_feed_id Y number The id of the balance feed
165 -- being deleted.
166 -- p_object_version_number Y number The version number of the feed
167 -- being deleted.
168 --
169 -- Post Success:
170 -- When the Balance Feed is deleted the following OUT parameters are set.
171 --
172 -- Name Type Description
173 -- P_EFFECTIVE_START_DATE DATE Effective Start Date
174 -- If p_validate is set to true this
175 -- will be set to NULL
176 -- P_EFFECTIVE_END_DATE DATE Effective End Date
177 -- If p_validate is set to true this
178 -- will be set to NULL
179 -- P_OBJECT_VERSION_NUMBER NUMBER Object Version Number
180 -- If p_validate is set to true this
181 -- will be set to NULL
182 -- P_EXIST_RUN_RESULT_WARNING BOOLEAN Will be set to TRUE if processed
183 -- run results exist
184 -- Post Failure:
185 -- Error Messages are raised if any business rule is violated and the balance
186 -- feed is not deleted
187 --
188 -- Access Status:
189 -- Public.
190 --
191 -- {End Of Comments}
192 --
193 procedure delete_balance_feed
194 (p_validate in boolean default false
195 ,p_effective_date in date
196 ,p_datetrack_delete_mode in varchar2
197 ,p_balance_feed_id in number
198 ,p_object_version_number in out nocopy number
199 ,p_effective_start_date out nocopy date
200 ,p_effective_end_date out nocopy date
201 ,p_exist_run_result_warning out nocopy boolean
202 );
203
204 end PAY_BALANCE_FEEDS_API;
[Home] [Help]