DBA Data[Home] [Help]

PACKAGE: APPS.HXC_TIME_ENTRY_RULE_GROUP_API

Source


1 Package hxc_time_entry_rule_group_api AUTHID CURRENT_USER as
2 /* $Header: hxctegapi.pkh 120.0 2005/05/29 05:58:53 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_time_entry_rule_group >------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 --
9 -- Description:
10 --
11 -- This API creates a entity group with a given name
12 --
13 -- Prerequisites:
14 --
15 -- None
16 --
17 -- In Parameters:
18 --   Name                           Reqd Type     Description
19 --
20 --   p_validate                     No   boolean  If TRUE then the database
21 --                                                remains unchanged. If FALSE
22 --                                                then a new data_approval_rule
23 --                                                is created. Default is FALSE.
24 --   p_time_entry_rule_group_id     No   number   Primary Key for time entry rule group
25 --   p_object_version_number        No   number   Object Version Number
26 --   p_name                         Yes  varchar2 Name for the time_entry_rule_group
27 --
28 -- Post Success:
29 --
30 -- when the time_entry_rule_group has been created successfully the following
31 -- out parameters are set.
32 --
33 --   Name                           Type     Description
34 --
35 --   p_time_entry_rule_group_id     Number   Primary Key for the new rule
36 --   p_object_version_number        Number   Object version number for the
37 --                                           new rule
38 --
39 -- Post Failure:
40 --
41 -- The time_entry_rule_group will not be inserted and an application error raised
42 --
43 -- Access Status:
44 --   Public.
45 --
46 --
47 procedure create_time_entry_rule_group
48   (p_validate                       in  boolean   default false
49   ,p_time_entry_rule_group_id       in  out nocopy number
50   ,p_object_version_number          in  out nocopy number
51   ,p_name                           in     varchar2
52   );
53     --
54 -- ----------------------------------------------------------------------------
55 -- |----------------------<update_time_entry_rule_group>----------------------|
56 -- ----------------------------------------------------------------------------
57 --
58 --
59 -- Description:
60 --
61 -- This API updates an existing Time_Entry_Rule_Group with a given name
62 --
63 -- Prerequisites:
64 --
65 -- None
66 --
67 -- In Parameters:
68 --   Name                           Reqd Type     Description
69 --
70 --   p_validate                     No   boolean  If TRUE then the database
71 --                                                remains unchanged. If FALSE
72 --                                                then the data_approval_rule
73 --                                                is updated. Default is FALSE.
74 --   p_time_entry_rule_group_id     Yes  number   Primary Key for entity
75 --   p_object_version_number        Yes  number   Object Version Number
76 --   p_name                         Yes  varchar2 Name for the time_entry_rule_group
77 --
78 -- Post Success:
79 --
80 -- when the time_entry_rule_group has been updated successfully the following
81 -- out parameters are set.
82 --
83 --   Name                           Type     Description
84 --
85 --   p_object_version_number        Number   Object version number for the
86 --                                           updated rule
87 --
88 -- Post Failure:
89 --
90 -- The time_entry_rule_group will not be updated and an application error raised
91 --
92 -- Access Status:
93 --   Public.
94 --
95 --
96 procedure update_time_entry_rule_group
97   (p_validate                       in  boolean   default false
98   ,p_time_entry_rule_group_id                     in  number
99   ,p_object_version_number          in  out nocopy number
100   ,p_name                           in     varchar2
101   );
102 --
103 -- ----------------------------------------------------------------------------
104 -- |-------------------< delete_time_entry_rule_group >-----------------------|
105 -- ----------------------------------------------------------------------------
106 --
107 --
108 -- Description:
109 --
110 -- This API deletes an existing Time_Entry_Rule_Group
111 --
112 -- Prerequisites:
113 --
114 -- None
115 --
116 -- In Parameters:
117 --   Name                           Reqd Type     Description
118 --
119 --   p_validate                     No   boolean  If TRUE then the database
120 --                                                remains unchanged. If FALSE
121 --                                                then the time_entry_rule_group
122 --                                                is deleted. Default is FALSE.
123 --   p_time_entry_rule_group_id     Yes  number   Primary Key for entity
124 --   p_object_version_number        Yes  number   Object Version Number
125 --
126 -- Post Success:
127 --
128 -- when the time_entry_rule_group has been deleted successfully the process
129 -- completes with success.
130 --
131 -- Post Failure:
132 --
133 -- The time_entry_rule_group will not be deleted and an application error raised
134 --
135 -- Access Status:
136 --   Public.
137 --
138 --
139 procedure delete_time_entry_rule_group
140   (p_validate                       in  boolean  default false
141   ,p_time_entry_rule_group_id       in  number
142   ,p_object_version_number          in  number
143   );
144 --
145 -- ----------------------------------------------------------------------------
146 -- |-----------------------< chk_name >---------------------------------------|
147 -- ----------------------------------------------------------------------------
148 --
149 -- Description:
150 --   This procedure insures a valid time entry rule group name
151 --
152 -- Pre Conditions:
153 --   None
154 --
155 -- In Arguments:
156 --   name
157 --   entity_group_id
158 --
159 -- Post Success:
160 --   Processing continues if the name business rules have not been violated
161 --
162 -- Post Failure:
163 --   An application error is raised if the name is not valid
164 --
165 -- ----------------------------------------------------------------------------
166 Procedure chk_name
167   (
168    p_name            in hxc_entity_groups.name%TYPE
169   ,p_entity_type     in hxc_entity_group_Comps.entity_type%TYPE
170   ,p_entity_group_id in hxc_entity_groups.entity_group_id%TYPE
171   );
172 --
173 -- ----------------------------------------------------------------------------
174 -- |-----------------------< chk_delete >-------------------------------------|
175 -- ----------------------------------------------------------------------------
176 --
177 -- Description:
178 --   This procedure carries out delete time referential integrity checks
179 --   to ensure that a time entry rule group is not being referenced in a
180 --   in an approval hierarchy.
181 --
182 -- Pre Conditions:
183 --   None
184 --
185 -- In Arguments:
186 --   entity_group_id
187 --
188 -- Post Success:
189 --   Processing continues if the name is not being referenced
190 --
191 -- Post Failure:
192 --   An application error is raised if the rule is being used.
193 --
194 -- ----------------------------------------------------------------------------
195 Procedure chk_delete
196   (
197    p_entity_group_id in hxc_entity_groups.entity_group_id%TYPE
198   ,p_entity_type     in hxc_entity_group_Comps.entity_type%TYPE
199   );
200 --
201 --
202 END hxc_time_entry_rule_group_api;