1 package hr_dt_attribute_support AUTHID CURRENT_USER as
2 /* $Header: dtattsup.pkh 115.1 2002/12/09 15:38:56 apholt ship $ */
3 -- ----------------------------------------------------------------------------
4 -- |-----------------------------< get_parameter_char >-----------------------|
5 -- ----------------------------------------------------------------------------
6 -- {Start Of Comments}
7 --
8 -- Description:
9 -- This function will return the character/varchar2 parameter value to be
10 -- used within a business process api.
11 --
12 -- If the parameter is being changed then it is added to the internal
13 -- structures and used for comparison operations on future rows.
14 --
15 -- Pre-Requisities:
16 -- The new and current value parameters must be in a varchar2 format.
17 --
18 -- In Parameters:
19 -- p_effective_date_row --> set to true if looking at the first row
20 -- p_parameter_name --> specifies the parameter name
21 -- p_new_value --> if on the first row then specifies the new
22 -- value to be used
23 -- p_current_value --> specifies the current row value
24 --
25 -- Post Success:
26 -- The function will be set to the correct value to be passed to
27 -- a BP API.
28 --
29 -- Post Failure:
30 -- None.
31 --
32 -- Developer Implementation Notes:
33 -- None
34 --
35 -- Access Status:
36 -- Internal Development Use Only.
37 --
38 -- {End Of Comments}
39 -- ----------------------------------------------------------------------------
40 function get_parameter_char
41 (p_effective_date_row in boolean default false
42 ,p_parameter_name in varchar2
43 ,p_new_value in varchar2 default null
44 ,p_current_value in varchar2) return varchar2;
45 -- ----------------------------------------------------------------------------
46 -- |----------------------< get_parameter_number >----------------------------|
47 -- ----------------------------------------------------------------------------
48 -- {Start Of Comments}
49 --
50 -- Description:
51 -- This function will return the number parameter value to be
52 -- used within a business process api.
53 --
54 -- If the parameter is being changed then it is added to the internal
55 -- structures and used for comparison operations on future rows.
56 --
57 -- Pre-Requisities:
58 -- The new and current value parameters must be in a number format.
59 --
60 -- In Parameters:
61 -- p_effective_date_row --> set to true if looking at the first row
62 -- p_parameter_name --> specifies the parameter name
63 -- p_new_value --> if on the first row then specifies the new
64 -- value to be used
65 -- p_current_value --> specifies the current row value
66 --
67 -- Post Success:
68 -- The function will be set to the correct value to be passed to
69 -- a BP API.
70 --
71 -- Post Failure:
72 -- None.
73 --
74 -- Developer Implementation Notes:
75 -- None
76 --
77 -- Access Status:
78 -- Internal Development Use Only.
79 --
80 -- {End Of Comments}
81 -- ----------------------------------------------------------------------------
82 function get_parameter_number
83 (p_effective_date_row in boolean default false
84 ,p_parameter_name in varchar2
85 ,p_new_value in number default null
86 ,p_current_value in number) return number;
87 -- ----------------------------------------------------------------------------
88 -- |------------------------< get_parameter_date >----------------------------|
89 -- ----------------------------------------------------------------------------
90 -- {Start Of Comments}
91 --
92 -- Description:
93 -- This function will return the date parameter value to be
94 -- used within a business process api.
95 --
96 -- If the parameter is being changed then it is added to the internal
97 -- structures and used for comparison operations on future rows.
98 --
99 -- Pre-Requisities:
100 -- The new and current value parameters must be in a date format.
101 --
102 -- In Parameters:
103 -- p_effective_date_row --> set to true if looking at the first row
104 -- p_parameter_name --> specifies the parameter name
105 -- p_new_value --> if on the first row then specifies the new
106 -- value to be used
107 -- p_current_value --> specifies the current row value
108 --
109 -- Post Success:
110 -- The function will be set to the correct value to be passed to
111 -- a BP API.
112 --
113 -- Post Failure:
114 -- None.
115 --
116 -- Developer Implementation Notes:
117 -- None
118 --
119 -- Access Status:
120 -- Internal Development Use Only.
121 --
122 -- {End Of Comments}
123 -- ----------------------------------------------------------------------------
124 function get_parameter_date
125 (p_effective_date_row in boolean default false
126 ,p_parameter_name in varchar2
127 ,p_new_value in date default null
128 ,p_current_value in date) return date;
129 -- ----------------------------------------------------------------------------
130 -- |-----------------------< is_current_row_changing >------------------------|
131 -- ----------------------------------------------------------------------------
132 -- {Start Of Comments}
133 --
134 -- Description:
135 -- This function determines if any attributes/parameters are being modified.
136 --
137 -- If true is returned then at least one attribute/parameter is being
138 -- modified. False is returned if no modifications are taking place.
139 --
140 -- Pre-Requisities:
141 -- None.
142 --
143 -- In Parameters:
144 -- None.
145 --
146 -- Post Success:
147 -- A boolean value will be returned.
148 --
149 -- Post Failure:
150 -- None.
151 --
152 -- Developer Implementation Notes:
153 -- None
154 --
155 -- Access Status:
156 -- Internal Development Use Only.
157 --
158 -- {End Of Comments}
159 -- ----------------------------------------------------------------------------
160 function is_current_row_changing return boolean;
161 -- ----------------------------------------------------------------------------
162 -- |---------------------< reset_parameter_statuses >-------------------------|
163 -- ----------------------------------------------------------------------------
164 -- {Start Of Comments}
165 --
166 -- Description:
167 -- This procedure will reset all of the internal attribute/parameter statuses
168 -- for changing parameters to true. This ensures that processing for past
169 -- rows can take place. This call should only be executed when the processing
170 -- of the current and future rows has taken place and before any past rows.
171 --
172 -- Pre-Requisities:
173 -- None.
174 --
175 -- In Parameters:
176 --
177 -- Post Success:
178 -- All internal parameters statuses are set to true.
179 --
180 -- Post Failure:
181 -- None.
182 --
183 -- Developer Implementation Notes:
184 -- None
185 --
186 -- Access Status:
187 -- Internal Development Use Only.
188 --
189 -- {End Of Comments}
190 -- ----------------------------------------------------------------------------
191 procedure reset_parameter_statuses;
192 --
193 end hr_dt_attribute_support;
[Home] [Help]