DBA Data[Home] [Help]

PACKAGE: APPS.HXC_TIME_CATEGORY_COMP_API

Source


1 Package hxc_time_category_comp_api as
2 /* $Header: hxctccapi.pkh 120.0 2005/05/29 05:55:52 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |------------------------< create_time_category_comp>-----------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- {Start Of Comments}
9 --
10 -- Description:
11 --
12 -- This API creates a Time Category Comp. The user is ablel to specify a name
13 -- for the component and the application field name the component relates
14 -- to.
15 --
16 -- Prerequisites:
17 --
18 -- None
19 --
20 -- In Parameters:
21 --   Name                           Reqd Type     Description
22 --
23 --   p_validate                     No   boolean  If TRUE then the database
24 --                                                remains unchanged. If FALSE
25 --                                                then a new time_category_comp
26 --                                                is created. Default is FALSE.
27 --   p_time_category_comp_id        Yes  number   Primary Key for entity
28 --   p_object_version_number        Yes  number   Object Version Number
29 --   p_time_category_id             Yes  number   FK to Master hxc_time_categories
30 --   p_ref_time_category_id         No   number   FK to hxc_time_categories
31 --   p_component_type_id            No   number   FK to hxc mapping components
32 --   p_flex_value_set_id            No   number   FK to fnd_flex_Value_sets
33 --   p_value_id                     No   Varchar  Value for segment identified by
34 --                                                mapping_component_id
35 --   p_is_null                      Yes  Varchar  Null Value ID is treated as IS NULL
36 --   p_equal_to                     Yes  Varchar  Evaluation is equal or not equal to
37 --   p_type                         Yes  Varchar  Type of the component
38 --
39 -- Post Success:
40 --
41 -- when the time_category_comp has been created successfully the following
42 -- out parameters are set.
43 --
44 --   Name                           Type     Description
45 --
46 --   p_time_category_comp_id        Number   Primary Key for the new rule
47 --   p_object_version_number        Number   Object version number for the
48 --                                           new rule
49 --
50 -- Post Failure:
51 --
52 -- The Time Category Comp will not be inserted and an application error raised
53 --
54 -- Access Status:
55 --   Public.
56 --
57 -- {End Of Comments}
58 --
59 procedure create_time_category_comp
60   (p_validate                       in  boolean   default false
61   ,p_time_category_comp_id          in  out nocopy number
62   ,p_object_version_number          in  out nocopy number
63   ,p_time_category_id               in  number
64   ,p_ref_time_category_id           in number
65   ,p_component_type_id                 number
66   ,p_flex_value_set_id            number
67   ,p_value_id                     Varchar2
68   ,p_is_null                        in varchar2
69   ,p_equal_to                       in varchar2
70   ,p_type                           in varchar2
71   );
72     --
73 -- ----------------------------------------------------------------------------
74 -- |------------------------<update_time_category_comp>------------------------|
75 -- ----------------------------------------------------------------------------
76 --
77 -- {Start Of Comments}
78 --
79 -- Description:
80 --
81 -- This API updates an existing Time Category Comp with a given name, approval
82 -- rule usage covering a particular date range.
83 --
84 -- Prerequisites:
85 --
86 -- None
87 --
88 -- In Parameters:
89 --   Name                           Reqd Type     Description
90 --
91 --   p_validate                     No   boolean  If TRUE then the database
92 --                                                remains unchanged. If FALSE
93 --                                                then the time_category_comp
94 --                                                is updated. Default is FALSE.
95 --   p_time_category_comp_id         Yes  number   Primary Key for entity
96 --   p_time_category_id             Yes  number   FK to Master hxc_time_categories
97 --   p_ref_time_category_id         No   number   FK to hxc_time_categories
98 --   p_component_type_id            No   number   FK to hxc mapping components
99 --   p_flex_value_set_id            No   number   FK to fnd_flex_Value_sets
100 --   p_value_id                     No   Varchar  Value for segment identified by
101 --                                                mapping_component_id
102 --   p_is_null                      Yes  Varchar  Null Value ID is treated as IS NULL
103 --   p_equal_to                     Yes  Varchar  Evaluation is equal or not equal to
104 --   p_type                         Yes  Varchar  Type of the component
105 
106 -- Post Success:
107 --
108 -- when the time_category_comp has been updated successfully the following
109 -- out parameters are set.
110 --
111 --   Name                           Type     Description
112 --
113 --   p_object_version_number        Number   Object version number for the
114 --                                           updated rule
115 --
116 -- Post Failure:
117 --
118 -- The Time Category Comp will not be updated and an application error raised
119 --
120 -- Access Status:
121 --   Public.
122 --
123 -- {End Of Comments}
124 --
125 procedure update_time_category_comp
126   (p_validate                       in  boolean   default false
127   ,p_time_category_comp_id           in  number
128   ,p_object_version_number          in  out nocopy number
129   ,p_time_category_id             number
130   ,p_ref_time_category_id         number
131   ,p_component_type_id            number
132   ,p_flex_value_set_id            number
133   ,p_value_id                     Varchar2
134   ,p_is_null                        in varchar2
135   ,p_equal_to                       in varchar2
136   ,p_type                           in varchar2
137   );
138 --
139 -- ----------------------------------------------------------------------------
140 -- |------------------------< delete_time_category_comp >---------------------|
141 -- ----------------------------------------------------------------------------
142 --
143 -- {Start Of Comments}
144 --
145 -- Description:
146 --
147 -- This API deletes an existing Time Category Comp
148 --
149 -- Prerequisites:
150 --
151 -- None
152 --
153 -- In Parameters:
154 --   Name                           Reqd Type     Description
155 --
156 --   p_validate                     No   boolean  If TRUE then the database
157 --                                                remains unchanged. If FALSE
158 --                                                then the time_category_comp
159 --                                                is deleted. Default is FALSE.
160 --   p_time_category_comp_id        Yes  number   Primary Key for entity
161 --   p_object_version_number        Yes  number   Object Version Number
162 --
163 -- Post Success:
164 --
165 -- when the time_category_comp has been deleted successfully the process
166 -- completes with success.
167 --
168 -- Post Failure:
169 --
170 -- The Time Category Comp will not be deleted and an application error raised
171 --
172 -- Access Status:
173 --   Public.
174 --
175 -- {End Of Comments}
176 --
177 procedure delete_time_category_comp
178   (p_validate                       in  boolean  default false
179   ,p_time_category_comp_id          in  number
180   ,p_object_version_number          in  number
181   );
182 --
183 --
184 END hxc_time_category_comp_api;