DBA Data[Home] [Help]

PACKAGE: APPS.WSM_INFINITE_SCHEDULER_GRP

Source


1 package wsm_infinite_scheduler_grp AUTHID CURRENT_USER as
2 /* $Header: WSMGIFSS.pls 115.2 2003/10/28 21:41:37 zchen noship $ */
3 
4 -------------------------------------------------------------------------
5 -- This API is a group API to schedule a lot based job based on
6 -- resources usages, assuming infinite resource availibility. It will
7 -- validate the parameter and call WSM private API to schedule the job.
8 -- and then update the schedule dates in WDJ, WO, WOR, WCO, WCOR.
9 -- OSFM scheduler will only schedule current and future operations
10 -- All the completed operations will not be re-scheduled
11 --
12 -- Parameters:
13 --  + p_initMsgList: Clear the message stack before processing?
14 --                   True (fnd_api.g_true) should be passed
15 --                   unless relevant messages are being saved
16 --                   on the stack. This value defaults to true.
17 --
18 --  + p_endDebug:    Pass true (fnd_api.g_true) unless the
19 --                   debug session will be ended at a later
20 --                   point by the caller. This value defaults
21 --                   to true
22 --
23 --  + p_orgID:       The organization of the entity.
24 --
25 --  + p_wipEntityID: The entity to reschedule.
26 --
27 -- + p_scheduleMode: will have the following values
28 --
29 --                   MIDPOINT           CONSTANT NUMBER := 6;
30 --                   MIDPOINT_FORWARDS  CONSTANT NUMBER := 7;
31 --                   MIDPOINT_BACKWARDS CONSTANT NUMBER := 8;
32 --                   CURRENT_OP         CONSTANT NUMBER := 9;
33 --                   CURRENT_SUB_GRP    CONSTANT NUMBER := 11;
34 --
35 --                   - If p_scheduleMode = WIP_CONSTANTS.CURRENT_OP,
36 --                     p_opSeqNum must be given, only operation
37 --                     p_opSeqNum will be scheduled
38 --                   - If p_scheduleMode = WIP_CONSTANTS.MIDPOINT,
39 --                     p_opSeqNum must be given, all the current and
40 --                     future operations will be scheduled
41 --                   - If p_scheduleMode = WIP_CONSTANTS.MIDPOINT_FORWARDS,
42 --                     p_opSeqNum must be given, all operations after and
43 --                     include p_opSeqNum will be scheduled
44 --                   - If p_scheduleMode = WIP_CONSTANTS.MIDPOINT_BACKWARDS,
45 --                     p_opSeqNum must be given, all operations before and
46 --                     include p_opSeqNum will be scheduled
47 --                   - If p_scheduleMode = WIP_CONSTANTS.CURRENT_SUB_GRP,
48 --                     p_opSeqNum and p_resSeqNum must be given, only
49 --                     resources with the same (substitute_group_number,
50 --                     replacement_group_number) as this resource will be
51 --                     scheduled
52 --
53 --  + p_startDate:   The start anchor date of either the operation
54 --                   or resource.
55 --
56 --  + p_endDate:     The end anchor date of either the operation
57 --                   or resource.
58 --
59 --  + p_opSeqNum:    Populate to midpoint schedule.
60 --                   Should be negative if passing current job op_seq_num,
61 --                   should be possitive if passing routing op_seq_num
62 --
63 --  + p_resSeqNum:   Populate to midpoint schedule down to the resource
64 --                   level, only used if p_opSeqNum is populated.
65 --                   pass -JOB_OP_SEQ_NUM if it is the current op
66 --
67 --  + x_returnStatus:fnd_api.g_ret_sts_success if the entity
68 --                   was scheduled successfully.
69 --
70 --  + x_errorMsg:    The error message. The error message will also
71 --                   be left on the stack.
72 -------------------------------------------------------------------------
73 
74 procedure schedule(
75         p_initMsgList   in varchar2 := null,
76         p_endDebug      in varchar2 := null,
77         p_orgID         in number,
78         p_wipEntityID   in number,
79         p_scheduleMode  in number   := null,
80         p_startDate     in date     := null,
81         p_endDate       in date     := null,
82         p_opSeqNum      in number   := null,      -- -1 if it is the current op
83         p_resSeqNum     in number   := null,
84         x_returnStatus  out nocopy varchar2,
85         x_errorMsg      out nocopy varchar2);
86 
87 end wsm_infinite_scheduler_grp;