DBA Data[Home] [Help]

PACKAGE: APPS.WMS_RE_CUSTOM_PUB

Source


1 package WMS_RE_Custom_PUB as
2 /* $Header: WMSPPPUS.pls 120.1 2005/05/27 02:01:16 appldev  $ */
3 
4   -- File        : WMSPPPUS.pls
5   -- Content     : WNS_RE_Custom_PUB package specification
6   -- Description : Customizable stub procedures and functions called during
7   --               WMS rules engine run.
8   -- Notes       :
9   -- Modified    : 02/08/99 mzeckzer created
10 
11   -- Local copies of fnd globals to prevent pragma violations of api functions
12   g_miss_num  constant number      := fnd_api.g_miss_num;
13   g_miss_char constant varchar2(1) := fnd_api.g_miss_char;
14   g_miss_date constant date        := fnd_api.g_miss_date;
15 
16   -- Start of comments
17   -- API name    : GetTotalLocationCapacity
18   -- Type        : Public
19   -- Function    : Calculates and returns the total capacity of a location
20   --               ( sub or sub/locator ) in a customer-specific manner
21   --               This function is made available to be used within put away
22   --               rule setup.
23   -- Pre-reqs    : none
24   -- Parameters  :
25   --  p_organization_id      in  number   required default = fnd_api.g_miss_num
26   --  p_subinventory_code    in  varchar2 required default = fnd_api.g_miss_char
27   --  p_locator_id           in  number   optional default = null
28   --  p_inventory_item_id    in  number   required default = fnd_api.g_miss_num
29   --  p_transaction_uom      in  varchar2 required default = fnd_api.g_miss_char
30   --  return value           out number
31   -- Version     : not tracked
32   -- Notes       : capacity should be returned as measured in txn UOM
33   -- End of comments
34 
35   function GetTotalLocationCapacity (
36            p_organization_id          number      := g_miss_num
37           ,p_subinventory_code        varchar2    := g_miss_char
38           ,p_locator_id               number      := null
39           ,p_inventory_item_id        number      := g_miss_num
40           ,p_transaction_uom          varchar2    := g_miss_char
41                                 ) return number;
42   pragma restrict_references(GetTotalLocationCapacity, WNDS, WNPS);
43 
44   -- Start of comments
45   -- API name    : GetOccupiedLocationCapacity
46   -- Type        : Public
47   -- Function    : Calculates and returns the occupied capacity of a location
48   --               ( sub or sub/locator ) in a customer-specific manner
49   --               This function is made available to be used within put away
50   --               rule setup.
51   -- Pre-reqs    : none
52   -- Parameters  :
53   --  p_organization_id      in  number   required default = fnd_api.g_miss_num
54   --  p_subinventory_code    in  varchar2 required default = fnd_api.g_miss_char
55   --  p_locator_id           in  number   optional default = null
56   --  p_inventory_item_id    in  number   required default = fnd_api.g_miss_num
57   --  p_transaction_uom      in  varchar2 required default = fnd_api.g_miss_char
58   --  return value           out number
59   -- Version     : not tracked
60   -- Notes       : capacity should be returned as measured in txn UOM
61   -- End of comments
62 
63   function GetOccupiedLocationCapacity (
64            p_organization_id          number      := g_miss_num
65           ,p_subinventory_code        varchar2    := g_miss_char
66           ,p_locator_id               number      := null
67           ,p_inventory_item_id        number      := g_miss_num
68           ,p_transaction_uom          varchar2    := g_miss_char
69                                    ) return number;
70   pragma restrict_references(GetOccupiedLocationCapacity, WNDS, WNPS);
71 
72   -- Start of comments
73   -- API name    : GetAvailableLocationCapacity
74   -- Type        : Public
75   -- Function    : Calculates and returns the available capacity of a location
76   --               ( sub or sub/locator ) in a customer-specific manner
77   --               This function is made available to be used within put away
78   --               rule setup.
79   -- Pre-reqs    : none
80   -- Parameters  :
81   --  p_organization_id      in  number   required default = fnd_api.g_miss_num
82   --  p_subinventory_code    in  varchar2 required default = fnd_api.g_miss_char
83   --  p_locator_id           in  number   optional default = null
84   --  p_inventory_item_id    in  number   required default = fnd_api.g_miss_num
85   --  p_transaction_quantity in  number   required default = fnd_api.g_miss_num
86   --  p_transaction_uom      in  varchar2 required default = fnd_api.g_miss_char
87   --  return value           out number
88   -- Version     : not tracked
89   -- Notes       : capacity must be returned as measured in txn UOM
90   -- End of comments
91 
92   function GetAvailableLocationCapacity (
93            p_organization_id          number      := g_miss_num
94           ,p_subinventory_code        varchar2    := g_miss_char
95           ,p_locator_id               number      := null
96           ,p_inventory_item_id        number      := g_miss_num
97           ,p_transaction_quantity     number      := g_miss_num
98           ,p_transaction_uom          varchar2    := g_miss_char
99                                     ) return number;
100   pragma restrict_references(GetAvailableLocationCapacity, WNDS, WNPS);
101 
102   -- Start of comments
103   -- API name    : GetRemainingLocationCapacity
104   -- Type        : Public
105   -- Function    : Calculates and returns the occupied capacity of a location
106   --               ( sub or sub/locator ) in a customer-specific manner
107   --               This function is made available to be used within put away
108   --               rule setup.
109   -- Pre-reqs    : none
110   -- Parameters  :
111   --  p_organization_id      in  number   required default = fnd_api.g_miss_num
112   --  p_subinventory_code    in  varchar2 required default = fnd_api.g_miss_char
113   --  p_locator_id           in  number   optional default = null
114   --  p_inventory_item_id    in  number   required default = fnd_api.g_miss_num
115   --  p_transaction_quantity in  number   required default = fnd_api.g_miss_num
116   --  p_transaction_uom      in  varchar2 required default = fnd_api.g_miss_char
117   --  return value           out number
118   -- Version     : not tracked
119   -- Notes       : capacity should be returned as measured in txn UOM
120   -- End of comments
121 
122   function GetRemainingLocationCapacity (
123            p_organization_id          number      := g_miss_num
124           ,p_subinventory_code        varchar2    := g_miss_char
125           ,p_locator_id               number      := null
126           ,p_inventory_item_id        number      := g_miss_num
127           ,p_transaction_quantity     number      := g_miss_num
128           ,p_transaction_uom          varchar2    := g_miss_char
129                                     ) return number;
130   pragma restrict_references(GetRemainingLocationCapacity, WNDS, WNPS);
131 
132   -- Start of comments
133   -- API name    : SearchForStrategy
134   -- Type        : Public
135   -- Function    : Searches for a pick or put away strategy assignment to a
136   --               customer-defined business object in a customer-specific
137   --               manner.
138   --               This procedure gets called just before the standard algorithm
139   --               which searches for strategy assignments to system-defined
140   --               business objects.
141   -- Pre-reqs    : transaction record in WMS_STRATEGY_MAT_TXN_TMP_V uniquely
142   --                identified by parameters p_transaction_temp_id and
143   --                p_type_code ( already validated by calling procedure )
144   --               set up strategy assignment in WMS_STRATEGY_ASSIGNMENTS
145   -- Parameters  :
146   --  p_init_msg_list        in  varchar2 optional default = fnd_api.g_false
147   --  x_return_status        out varchar2(1)
148   --  x_msg_count            out number
149   --  x_msg_data             out varchar2(2000)
150   --  p_transaction_temp_id  in  number   required default = fnd_api.g_miss_num
151   --  p_type_code            in  number   required default = fnd_api.g_miss_num
152   --  x_strategy_id          out number
153   -- Version     : not tracked
154   -- Notes       : type code of returned strategy has to match type code
155   --               parameter
156   -- End of comments
157 
158   procedure SearchForStrategy (
159             p_init_msg_list        in   varchar2 := fnd_api.g_false
160            ,x_return_status        out NOCOPY varchar2
161            ,x_msg_count            out NOCOPY  number
162            ,x_msg_data             out NOCOPY varchar2
163            ,p_transaction_temp_id  in   number   := fnd_api.g_miss_num
164            ,p_type_code            in   number   := fnd_api.g_miss_num
165            ,x_strategy_id          out NOCOPY  number
166            );
167 
168    /**
169 
170     API name    : SearchForStrategy
171     Type        : Public
172     Function    : Searches for a wms strategy/rule/value assignment to a
173                   customer-defined business object in a customer-specific
174                   manner.
175     Pre-reqs    : transaction record in WMS_STRATEGY_MAT_TXN_TMP_V uniquely
176                    identified by parameters p_transaction_temp_id and
177                    p_type_code ( already validated by calling procedure )
178                   set up strategy assignment in WMS_STRATEGY_ASSIGNMENTS
179     Parameters  :
180      p_init_msg_list        in  varchar2 optional default = fnd_api.g_false
181      x_return_status        out varchar2(1)
182      x_msg_count            out number
183      x_msg_data             out varchar2(2000)
184      p_transaction_temp_id  in  number   required default = fnd_api.g_miss_num
185      p_type_code            in  number   required default = fnd_api.g_miss_num
186      x_return_type          out  varchar2 'V' for Value , 'R' for Rule , 'S' for strategy
187     ,x_return_type_id       out  number
188       Notes       : type code of returned strategy has to match type code
189                   parameter
190   */
191   procedure SearchForStrategy (
192             p_init_msg_list        in   varchar2 := fnd_api.g_false
193            ,x_return_status        out NOCOPY varchar2
194            ,x_msg_count            out NOCOPY number
195            ,x_msg_data             out NOCOPY varchar2
196            ,p_transaction_temp_id  in   number   := fnd_api.g_miss_num
197            ,p_type_code            in   number   := fnd_api.g_miss_num
198            ,x_return_type          out  NOCOPY varchar2 -- 'V' for Value , 'R' for Rule , 'S' for strategy
199            ,x_return_type_id       out  NOCOPY number
200            );
201 
202 end WMS_RE_Custom_PUB;