1 PACKAGE AHL_UMP_UNITMAINT_PUB AS
2 /* $Header: AHLPUMXS.pls 120.0 2005/05/26 00:08:39 appldev noship $ */
3 /*#
4 * Builds and Calculates Unit and Item instance Maintenance Plan Schedule. Also Updates unit and item instance Maintenance Plan Schedule
5 * with deferral and accomplishment details.
6 * @rep:scope public
7 * @rep:product AHL
8 * @rep:displayname Maintain Unit Maintenance Plan Schedule
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY AHL_UNIT_EFFECTIVITY
11 */
12
13 ------------------------
14 -- Declare Procedures --
15 ------------------------
16
17 -- Start of Comments --
18 -- Procedure name : Capture_MR_Updates
19 -- Type : Public
20 -- Function : For a given set of instances, will record their statuses with either
21 -- accomplishment date or deferred-next due date or termination date with
22 -- their corresponding counter and counter values.
23 -- Pre-reqs :
24 -- Parameters :
25 --
26 -- Standard IN Parameters :
27 -- p_api_version IN NUMBER Default 1.0
28 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_TRUE
29 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
30 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
31 -- Standard OUT Parameters :
32 -- x_return_status OUT VARCHAR2 Required
33 -- x_msg_count OUT NUMBER Required
34 -- x_msg_data OUT VARCHAR2 Required
35 --
36 -- p_module_type IN VARCHAR2 Required.
37 -- This parameter indicates the front-end form interface. The default value is 'JSP'. If the value
38 -- is JSP, then this API clears out all id columns and validations are done using the values based
39 -- on which the Id's are populated.
40 --
41 -- Capture MR Update Parameters:
42 -- p_unit_Effectivity_tbl IN Unit_Effectivity_tbl_type Required
43 -- List of all unit effectivities whose status, due or accomplished dates
44 -- and counter values need to be captured
45 -- p_x_Unit_Threshold_tbl IN OUT Unit_Threshold_tbl_type Required
46 -- List of all thresholds (counters and counter values) when a MR becomes due
47 -- p_x_Unit_Accomplish_tbl IN OUT Unit_Accomplish_tbl_type Required
48 -- List of all counters and corresponding counter values when the MR was last accomplished
49 --
50 --
51 -- Version :
52 -- Initial Version 1.0
53 --
54 -- End of Comments.
55 /*#
56 * For a given set of instances, records their statuses with either accomplishment date or deferred-next due date
57 * or termination date with their corresponding counter and counter values.
58 * @param p_api_version Api Version Number
59 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
60 * @param p_commit to decide whether to commit the transaction or not, default value FND_API.G_FALSE
61 * @param p_validation_level validation level, default value FND_API.G_VALID_LEVEL_FULL
62 * @param p_unit_Effectivity_tbl Unit Effectivity Table of type AHL_UMP_UNITMAINT_PVT.Unit_Effectivity_tbl_type
63 * @param p_x_unit_threshold_tbl Unit Thresholds Details Table of type AHL_UMP_UNITMAINT_PVT.Unit_Threshold_tbl_type
64 * @param p_x_unit_accomplish_tbl Unit Accomplishment Details Table of type AHL_UMP_UNITMAINT_PVT.Unit_Threshold_tbl_type
65 * @param x_return_status return status
66 * @param x_msg_count return message count
67 * @param x_msg_data return message data
68 * @rep:scope public
69 * @rep:lifecycle active
70 * @rep:displayname Capture Unit Maintenance Plan Updates
71 */
72 PROCEDURE Capture_MR_Updates (
73 p_api_version IN NUMBER := 1.0,
74 p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE,
75 p_commit IN VARCHAR2 := FND_API.G_FALSE,
76 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
77 p_unit_Effectivity_tbl IN AHL_UMP_UNITMAINT_PVT.Unit_Effectivity_tbl_type,
78 p_x_unit_threshold_tbl IN OUT NOCOPY AHL_UMP_UNITMAINT_PVT.Unit_Threshold_tbl_type,
79 p_x_unit_accomplish_tbl IN OUT NOCOPY AHL_UMP_UNITMAINT_PVT.Unit_Accomplish_tbl_type,
80 x_return_status OUT NOCOPY VARCHAR2,
81 x_msg_count OUT NOCOPY NUMBER,
82 x_msg_data OUT NOCOPY VARCHAR2);
83
84
85
86 ----------------------------------------
87 -- Declare Procedures for Terminate MR Instances --
88 ----------------------------------------
89 -- Start of Comments --
90 -- Procedure name : Terminate_MR_Instances
91 -- Type : Public
92 -- Function : Terminate MR Instances
93 -- Pre-reqs :
94 -- Parameters :
95 --
96 -- Standard IN Parameters :
97 -- p_api_version IN NUMBER Required
98 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
99 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
100 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
101 -- Standard OUT Parameters :
102 -- x_return_status OUT VARCHAR2 Required
103 -- x_msg_count OUT NUMBER Required
104 -- x_msg_data OUT VARCHAR2 Required
105 --
106 -- p_module_type IN VARCHAR2 Required.
107 -- This parameter indicates the front-end form interface. The default value is null. If the value
108 -- is JSP, then this API clears out all id columns and validations are done using the values;based
109 -- on which the Id's are populated.
110 --
111 -- Terminate_MR_Instances Parameters :
112 -- p_mr_header_id IN VARCHAR2,
113 -- p_old_mr_header_id IN VARCHAR2,
114
115 --
116 -- Version :
117 -- Initial Version 1.0
118 --
119 -- End of Comments.
120 /*#
121 * Terminate a Unit Maintenance Plan Schedule based on termination of a Maintenance Requirement. Also creates a new Unit Maintenance
122 * Plan based on new Maintenance Requirementthat replaces the terminated Maintenance Requirement.
123 * @param p_api_version Api Version Number
124 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
125 * @param p_commit to decide whether to commit the transaction or not, default value FND_API.G_FALSE
126 * @param p_validation_level validation level, default value FND_API.G_VALID_LEVEL_FULL
127 * @param p_module_type Module Type Value always NULL, For internal use
128 * @param p_default Defaulting , default value FND_API.G_TRUE
129 * @param p_old_mr_header_id Terminated Maintenance Requirement ID
130 * @param p_old_mr_title Terminated Maintenance Requirement Title
131 * @param p_old_version_number Terminated Maintenance Requirement Version Number
132 * @param p_new_mr_header_id New Maintenance Requirement ID
133 * @param p_new_mr_title New Maintenance Requirement Title
134 * @param p_new_version_number New Maintenance Requirement Version Number
135 * @param x_return_status return status
136 * @param x_msg_count return message count
137 * @param x_msg_data return message data
138 * @rep:scope public
139 * @rep:lifecycle active
140 * @rep:displayname Terminate Unit Maintenance Plan Schedule
141 */
142 PROCEDURE Terminate_MR_Instances (
143 p_api_version IN NUMBER := 1.0,
144 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
145 p_commit IN VARCHAR2 := FND_API.G_FALSE,
146 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
147 p_default IN VARCHAR2 := FND_API.G_TRUE,
148 p_module_type IN VARCHAR2 := NULL,
149 p_old_mr_header_id IN NUMBER,
150 p_old_mr_title IN VARCHAR2,
151 p_old_version_number IN NUMBER,
152 p_new_mr_header_id IN NUMBER := NULL,
153 p_new_mr_title IN VARCHAR2 := NULL,
154 p_new_version_number IN NUMBER := NULL,
155 x_return_status OUT NOCOPY VARCHAR2,
156 x_msg_count OUT NOCOPY NUMBER,
157 x_msg_data OUT NOCOPY VARCHAR2 );
158
159
160
161 -- Start of Comments --
162 -- Procedure name : Process_UnitEffectivity
163 -- Type : Private
164 -- Function : Manages Create/Modify/Delete operations of applicable maintenance
165 -- requirements on a unit.
166 -- Pre-reqs :
167 -- Parameters :
168 --
169 -- Standard IN Parameters :
170 -- p_api_version IN NUMBER Required
171 -- p_init_msg_list IN VARCHAR2 Default FND_API.G_FALSE
172 -- p_commit IN VARCHAR2 Default FND_API.G_FALSE
173 -- p_validation_level IN NUMBER Default FND_API.G_VALID_LEVEL_FULL
174 -- p_default IN VARCHAR2 Default FND_API.G_TRUE
175 -- Based on this flag, the API will set the default attributes.
176 -- p_module_type In VARCHAR2 Default NULL
177 -- This will be null.
178 -- Standard OUT Parameters :
179 -- x_return_status OUT VARCHAR2 Required
180 -- x_msg_count OUT NUMBER Required
181 -- x_msg_data OUT VARCHAR2 Required
182 --
183 -- Process_UnitEffectivity Parameters :
184 -- If no input parameters are passed, then effectivity will be built for all units.
185 -- If either p_mr_header_id OR p_mr_title and p_mr_version_number are passed, then effectivity
186 -- will be built for all units having this maintenance requirement; p_mr_header_id being the unique
187 -- identifier of a maintenance requirement.
188 -- If either p_csi_item_instance_id OR p_csi_instance_number are passed, then effectivity
189 -- will be built for the unit this item instance belongs to.
190 -- If either p_unit_name OR p_unit_config_header_id are passed, then effectivity will be
191 -- built for the unit configuration.
192 --
193 /*#
194 * Builds applicable Unit Maintenance Plan Schedule for a Unit or Item Instance
195 * @param p_api_version Api Version Number
196 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
197 * @param p_commit to decide whether to commit the transaction or not, default value FND_API.G_FALSE
198 * @param p_validation_level validation level, default value FND_API.G_VALID_LEVEL_FULL
199 * @param p_default Defaulting , default value FND_API.G_TRUE
200 * @param p_module_type Module Type Value always NULL, For internal use
201 * @param p_mr_header_id Maintenance Requirement Header ID
202 * @param p_mr_title Maintenance Requirement Title
203 * @param p_mr_version_number Maintenance Requirement Version Number
204 * @param p_unit_config_header_id Unit Configuration Header ID
205 * @param p_unit_name Unit Configuration Name
206 * @param p_csi_item_instance_id CSI Item Instance ID
207 * @param p_csi_instance_number CSI Item Instance Number
208 * @param x_return_status return status
209 * @param x_msg_count return message count
210 * @param x_msg_data return message data
211 * @rep:scope public
212 * @rep:lifecycle active
213 * @rep:displayname Process Unit Maintenance Plan Schedule
214 */
215 PROCEDURE Process_UnitEffectivity (
216 p_api_version IN NUMBER,
217 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
218 p_commit IN VARCHAR2 := FND_API.G_FALSE,
219 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
220 p_default IN VARCHAR2 := FND_API.G_TRUE,
221 p_module_type IN VARCHAR2 := NULL,
222 x_return_status OUT NOCOPY VARCHAR2,
223 x_msg_count OUT NOCOPY NUMBER,
224 x_msg_data OUT NOCOPY VARCHAR2,
225 p_mr_header_id IN NUMBER := NULL,
226 p_mr_title IN VARCHAR2 := NULL,
227 p_mr_version_number IN NUMBER := NULL,
228 p_unit_config_header_id IN NUMBER := NULL,
229 p_unit_name IN VARCHAR2 := NULL,
230 p_csi_item_instance_id IN NUMBER := NULL,
231 p_csi_instance_number IN VARCHAR2 := NULL
232
233 );
234
235
236 End AHL_UMP_UNITMAINT_PUB;
[Home] [Help]