DBA Data[Home] [Help]

PACKAGE: APPS.WIP_MOVPROC_PUB

Source


1 PACKAGE wip_movProc_pub AS
2 /* $Header: wipmvpbs.pls 120.0 2005/05/25 08:18:17 appldev noship $*/
3 
4 /***************************************************************************
5  * This procedure will be used to do move, easy-return, easy-completion, and
6  * scrap transaction for Discrete, OSFM jobs, and Repetitive Schedule. The
7  * caller need to insert the record into WIP_MOVE_TXN_INTERFACE before calling
8  * this routine. Caller can generate wmti.transaction_id and wmti.group_id
9  * from the sequence wip_transactions_s. Caller need to insert both group_id
10  * and transaction_id before calling the procedure below. These 2 columns
11  * should have to same value. Caller should always insert wmti.process_phase =
12  * 1(Validation) to make sure that the data inserted is valid, and insert
13  * wmti.process_status = 2(Running) to prevent Move Manager from picking up
14  * this record.
15  *
16  * PARAMETER:
17  *
18  * p_txn_id             transaction_id in WIP_MOVE_TXN_INTERFACE
19  * p_do_backflush       this parameter determine whether move procesor has to
20  *                      backflush pull component or not. Some customers use
21  *                      third party software to insert backflush components, so
22  *                      they do not want move processor to backflush them
23  *                      again. The default value is null. If the callers do not
24  *                      pass this parameter or pass fnd_api.g_true, we will
25  *                      backflush pull component. Otherwise, we will not
26  *                      backflush them. pass fnd_api.g_true or fnd_api.g_false.
27  * p_commmit            commit the change to the database if succesfully
28  *                      processing ? pass
29  *                      fnd_api.g_true or fnd_api.g_false
30  * x_returnStatus       There are 2 possible values
31  *                      *fnd_api.g_ret_sts_success*
32  *                      means the move transaction succesfully processed
33  *                      *fnd_api.g_ret_sts_unexp_error*
34  *                      means an exception occurred
35  *                      The size of this variable should be VARCHAR2(1)
36  * x_errorMsg           contains the error message on failure. null on success.
37  *                      The size of this variable should be VARCHAR2(1000)
38  *                      because there may be errors in several columns.
39  *
40  * NOTE:
41  * 1. This procedure should be called if caller want to process one record at
42  *    a time such as Online transaction.
43  * 2. This procedure will return fnd_api.g_ret_sts_unexp_error if this records
44  *    failed. The caller can check the error message from x_errorMsg.
45  * 3. The caller does not have to insert child record for overmove/
46  *    overcompletion. This API will take care everything. The caller does not
47  *    have to call QA API either.
48  ***************************************************************************/
49 PROCEDURE processInterface(p_txn_id       IN         NUMBER,
50                            p_do_backflush IN         VARCHAR2 := NULL,
51                            p_commit       IN         VARCHAR2,
52                            x_returnStatus OUT NOCOPY VARCHAR2,
53                            x_errorMsg     OUT NOCOPY VARCHAR2);
54 
55 /***************************************************************************
56  * This procedure will be used to do move, easy-return, easy-completion, and
57  * scrap transaction for Discrete, OSFM jobs, and Repetitive Schedule. The
58  * caller need to insert the record into WIP_MOVE_TXN_INTERFACE before calling
59  * this routine. Caller can generate wmti.group_id from the sequence
60  * wip_transactions_s. Only group_id is mandatory for procedure below. Caller
61  * does not have to insert transaction_id. Caller should always insert
62  * wmti.process_phase = 1(Validation) to make sure that the data inserted are
63  * valid, and insert wmti.process_status = 2(Running) to prevent Move Manager
64  * from picking up these records.
65  *
66  * PARAMETER:
67  *
68  * p_group_id           group_id in WIP_MOVE_TXN_INTERFACE
69  * p_do_backflush       this parameter determine whether move procesor has to
70  *                      backflush pull component or not. Some customers use
71  *                      third party software to insert backflush components, so
72  *                      they do not want move processor to backflush them
73  *                      again. The default value is null. If the callers do not
74  *                      pass this parameter or pass fnd_api.g_true, we will
75  *                      backflush pull component. Otherwise, we will not
76  *                      backflush them. pass fnd_api.g_true or fnd_api.g_false.
77  * p_commmit            commit the change to the database if no record in this
78  *                      group error out ? pass
79  *                      fnd_api.g_true or fnd_api.g_false
80  * x_returnStatus       There are 2 possible values
81  *                      *fnd_api.g_ret_sts_success*
82  *                      means the move transaction succesfully processed
83  *                      *fnd_api.g_ret_sts_unexp_error*
84  *                      means an exception occurred
85  *                      The size of this variable should be VARCHAR2(1)
86  *
87  * NOTE:
88  * 1. This procedure should be called if caller want to do batch processing for
89  *    multiple records in WMTI.
90  * 2. This procedure will return fnd_api.g_ret_sts_unexp_error if one or more
91  *    records in this group_id failed. The caller can check the error message,
92  *    and error column from WIP_TXN_INTERFACE_ERRORS.
93  * 3. The caller does not have to insert child record for overmove/
94  *    overcompletion. This API will take care everything. The callter does not
95  *    have to call QA API either.
96  ***************************************************************************/
97 PROCEDURE processInterface(p_group_id     IN         NUMBER,
98                            p_do_backflush IN         VARCHAR2 := NULL,
99                            p_commit       IN         VARCHAR2,
100                            x_returnStatus OUT NOCOPY VARCHAR2);
101 END wip_movProc_pub;