1 Package pay_dated_tables_api as
2 /* $Header: pyptaapi.pkh 120.0 2005/05/29 07:55:56 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------<create_dated_table >-------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This API is used to create rows on pay_dated_tables table
11 --
12 -- Prerequisites:
13 -- None
14 --
15 -- In Parameters:
16 -- Name Reqd Type Description
17 -- p_validate Yes boolean Commit or Rollback.
18 -- p_table_name Yes varchar2 Table Name
19 -- p_application_id No number Application id for the table
20 -- name in p_table_name argument.
21 -- p_surrogate_key_name Yes varchar2 Has to be a column on the table.
22 -- p_start_date_name Yes varchar2 Has to be a column on the table
23 -- of data type date.
24 -- p_end_date_name Yes varchar2 Has to be a column on the table
25 -- of data type date.
26 -- p_business_group_id No number Business Group of the Record.
27 -- p_legislation_code No varchar2 Legislation Code
28 -- p_dyn_trigger_type No varchar2 From lookup pay_dyn_trigger_types
29 -- p_dyn_trigger_package_name No varchar2 If package to hold trigger code, then name given
30 -- p_dyn_trig_pkg_generated No varchar2 A flag indicating this pkg exists
31 --
32 -- Out Parameters:
33 -- Name Type Description
34 -- p_dated_table_id number PK of record
35 -- p_object_version_number number OVN of record
36 --
37 -- Post Failure:
38 -- 1) If the surrogate key name argument is not a column on the table specified
39 -- in the table name argument, raise error HR_xxxx_SURROGATE_KEY_NAME.
40 -- 2) If the start date name argument is not a column of data type Date on the
41 -- table in the table name argument, raise error HR_xxxx_START_DATE_NAME.
42 -- 3) If the end date name argument is not a column of data type Date on the
43 -- table in the table name argument, raise error HR_xxxx_END_DATE_NAME.
44 --
45 -- Access Status:
46 -- Public.
47 --
48 -- {End Of Comments}
49 --
50 procedure create_dated_table
51 (
52 p_validate in boolean default false
53 ,p_table_name in varchar2
54 ,p_application_id in number default null
55 ,p_surrogate_key_name in varchar2
56 ,p_start_date_name in varchar2
57 ,p_end_date_name in varchar2
58 ,p_business_group_id in number default null
59 ,p_legislation_code in varchar2 default null
60 ,p_dated_table_id out nocopy number
61 ,p_object_version_number out nocopy number
62 ,p_dyn_trigger_type in varchar2 default null
63 ,p_dyn_trigger_package_name in varchar2 default null
64 ,p_dyn_trig_pkg_generated in varchar2 default null
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |--------------------------<update_dated_table >-------------------------|
69 -- ----------------------------------------------------------------------------
70 -- {Start Of Comments}
71 --
72 -- Description:
73 -- This API is used to update rows on pay_dated_tables table
74 --
75 -- Prerequisites:
76 -- None
77 --
78 -- In Parameters:
79 -- Name Reqd Type Description
80 -- p_validate Yes boolean Commit or Rollback.
81 -- p_dated_table_id Yes number PK of record
82 -- p_object_version_number Yes number OVN of record
83 -- p_table_name No varchar2 Table Name
84 -- p_application_id No number Application id for the table
85 -- name in p_table_name argument.
86 -- p_surrogate_key_name No varchar2 Has to be a column on the table
87 -- name in p_table_name argument
88 -- p_start_date_name No varchar2 Has to be a column on the table
89 -- of data type date.
90 -- p_end_date_name No varchar2 Has to be a column on the table
91 -- of data type date.
92 -- p_business_group_id No number Business Group of the Record.
93 -- p_legislation_code No varchar2 Legislation Code
94 -- p_dyn_trigger_type No varchar2 From lookup pay_dyn_trigger_type
95 -- p_dyn_trigger_package_name No varchar2 If package to hold trigger code, then name given
96 -- p_dyn_trig_pkg_generated No varchar2 Flag indicating pkg exists.
97 --
98 -- Out Parameters:
99 -- Name Type Description
100 -- p_object_version_number number OVN of record
101 --
102 -- Post Failure:
103 -- 1) If the surrogate key name argument is not a column on the table specified
104 -- in the table name argument, raise error HR_xxxx_SURROGATE_KEY_NAME.
105 -- 2) If the start date name argument is not a column of data type Date on the
106 -- table in the table name argument, raise error HR_xxxx_START_DATE_NAME.
107 -- 3) If the end date name argument is not a column of data type Date on the
108 -- table in the table name argument, raise error HR_xxxx_END_DATE_NAME.
109 -- Access Status:
110 -- Public.
111 --
112 -- {End Of Comments}
113 --
114 procedure update_dated_table
115 (
116 p_validate in boolean default false
117 ,p_dated_table_id in number
118 ,p_object_version_number in out nocopy number
119 ,p_table_name in varchar2 default hr_api.g_varchar2
120 ,p_application_id in number default hr_api.g_number
121 ,p_surrogate_key_name in varchar2 default hr_api.g_varchar2
122 ,p_start_date_name in varchar2 default hr_api.g_varchar2
123 ,p_end_date_name in varchar2 default hr_api.g_varchar2
124 ,p_business_group_id in number default hr_api.g_number
125 ,p_legislation_code in varchar2 default hr_api.g_varchar2
126 ,p_dyn_trigger_type in varchar2 default hr_api.g_varchar2
127 ,p_dyn_trigger_package_name in varchar2 default hr_api.g_varchar2
128 ,p_dyn_trig_pkg_generated in varchar2 default hr_api.g_varchar2
129 );
130 --
131 -- ----------------------------------------------------------------------------
132 -- |--------------------------< delete_dated_table >--------------------------|
133 -- ----------------------------------------------------------------------------
134 -- {Start Of Comments}
135 --
136 -- Description:
137 -- This API deletes an existing row on pay_dated_tables table
138 --
139 -- Prerequisites:
140 -- None
141 --
142 -- In Parameters:
143 -- Name Reqd Type Description/Valid Values
144 -- p_validate Yes boolean Commit or Rollback.
145 -- FALSE(default) or TRUE
146 -- p_dated_table_id Yes number PK of record
147 -- p_object_version_number Yes number OVN of record
148 --
149 -- Post Failure:
150 --
151 -- Access Status:
152 -- Public.
153 --
154 -- {End Of Comments}
155 --
156 procedure delete_dated_table
157 (
158 p_validate in boolean default false
159 ,p_dated_table_id in number
160 ,p_object_version_number in number
161 );
162 end pay_dated_tables_api;
[Home] [Help]