1 Package pay_ppe_api as
2 /* $Header: pyppeapi.pkh 120.1.12010000.1 2008/07/27 23:25:09 appldev ship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< create_process_event >-------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This API is used to create rows on pay_process_events 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_assignment_id No number Identifies the assignment
19 -- p_effective_date Yes date Session Date.
20 -- p_change_type Yes varchar2 Taken from PROCESS_EVENT_TYPE
21 -- lookup
22 -- p_status Yes varchar2 Taken from PROCESS_EVENT_STATUS
23 -- lookup
24 -- p_description No varchar2 Description
25 -- p_event_update_id No number FK to Pay_Event_Update table.
26 -- p_org_process_event_group_id No number
27 -- p_business_group_id No number Business Group of the Record.
28 -- p_surrogate_key No varchar2
29 -- p_calculation_date No date
30 -- p_retroactive_status No varchar
31 --
32 -- Out Parameters:
33 -- Name Type Description
34 -- p_process_event_id number PK of record
35 -- p_object_version_number number OVN of record
36 --
37 -- Post Failure:
38 -- 1) If the change type argument is not a recognisable value for the lookup
39 -- type PROCESS_EVENT_TYPE, then raise error HR_xxxx_INVALID_EVENT_TYPE.
40 -- 2) If the status argument is not a recognisable value for the lookup
41 -- type PROCESS_EVENT_STATUS, then raise error HR_xxxx_INVALID_STATUS_TYPE.
42 --
43 -- Access Status:
44 -- Public.
45 --
46 -- {End Of Comments}
47 --
48 procedure create_process_event
49 (
50 p_validate in boolean default false
51 ,p_assignment_id in number default null
52 ,p_effective_date in date
53 ,p_change_type in varchar2
54 ,p_status in varchar2
55 ,p_description in varchar2 default null
56 ,p_process_event_id out nocopy number
57 ,p_object_version_number out nocopy number
58 ,p_event_update_id in number default null
59 ,p_org_process_event_group_id in number default null
60 ,p_business_group_id in number default null
61 ,p_surrogate_key in varchar2 default null
62 ,p_calculation_date in date default null
63 ,p_retroactive_status in varchar2 default null
64 ,p_noted_value in varchar2 default null
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |--------------------------<update_process_event >-------------------------|
69 -- ----------------------------------------------------------------------------
70 -- {Start Of Comments}
71 --
72 -- Description:
73 -- This API updates an existing row on pay_process_events 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_process_event_id Yes number PK of record
82 -- p_object_version_number Yes number OVN of record
83 -- p_assignment_id No number Identifies the assignment
84 -- p_effective_date No date Session Date.
85 -- p_change_type No varchar2 Taken from PROCESS_EVENT_TYPE
86 -- lookup
87 -- p_status No varchar2 Taken from PROCESS_EVENT_STATUS
88 -- lookup
89 -- p_description No varchar2 Description
90 -- p_event_update_id No number FK to Pay_Event_Update table.
91 -- p_org_process_event_group_id No number
92 -- p_business_group_id No number Business Group of the Record.
93 -- p_surrogate_key No varchar2
94 -- p_calculation_date No date
95 -- p_retroactive_status No varchar
96 --
97 -- Out Parameters:
98 -- Name Type Description
99 -- p_object_version_number number OVN of record
100 --
101 -- Post Failure:
102 -- 1) If the change type argument is not a recognisable value for the lookup
103 -- type PROCESS_EVENT_TYPE, then raise error HR_xxxx_INVALID_EVENT_TYPE.
104 -- 2) If the status argument is not a recognisable value for the lookup
105 -- type PROCESS_EVENT_STATUS, then raise error HR_xxxx_INVALID_STATUS_TYPE.
106 --
107 -- Access Status:
108 -- Public.
109 --
110 -- {End Of Comments}
111 --
112 procedure update_process_event
113 (
114 p_validate in boolean default false
115 ,p_process_event_id in number
116 ,p_object_version_number in out nocopy number
117 ,p_assignment_id in number default hr_api.g_number
118 ,p_effective_date in date default hr_api.g_date
119 ,p_change_type in varchar2 default hr_api.g_varchar2
120 ,p_status in varchar2 default hr_api.g_varchar2
121 ,p_description in varchar2 default hr_api.g_varchar2
122 ,p_event_update_id in number default hr_api.g_number
123 ,p_org_process_event_group_id in number default hr_api.g_number
124 ,p_business_group_id in number default hr_api.g_number
125 ,p_surrogate_key in varchar2 default hr_api.g_varchar2
126 ,p_calculation_date in date default hr_api.g_date
127 ,p_retroactive_status in varchar2 default hr_api.g_varchar2
128 ,p_noted_value in varchar2 default hr_api.g_varchar2
129 );
130 --
131 -- ----------------------------------------------------------------------------
132 -- |--------------------------< delete_process_event >--------------------------|
133 -- ----------------------------------------------------------------------------
134 -- {Start Of Comments}
135 --
136 -- Description:
137 -- This API deletes an existing row on pay_event_updates 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_process_event_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_process_event
157 (
158 p_validate in boolean default false
159 ,p_process_event_id in number
160 ,p_object_version_number in number
161 );
162 end pay_ppe_api;