Source code for anyblok_wms_base.core.operation.departure

# -*- coding: utf-8 -*-
# This file is a part of the AnyBlok / WMS Base project
#
#    Copyright (C) 2018 Georges Racinet <gracinet@anybox.fr>
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file,You can
# obtain one at http://mozilla.org/MPL/2.0/.

from anyblok import Declarations
from anyblok.column import Integer

register = Declarations.register
Mixin = Declarations.Mixin
Operation = Declarations.Model.Wms.Operation


[docs]@register(Operation)
class Departure(Mixin.WmsSingleInputOperation, Operation):
    """Operation to represent goods physically leaving the system.

    Downstream libraries and applications can enhance this model
    with additional information (e.g., a shipping address) if needed, although
    it's probably a better design for rich shipment representation to issue
    separate Models and relation tables.
    """
    TYPE = 'wms_departure'

    id = Integer(label="Identifier",
                 primary_key=True,
                 autoincrement=False,
                 foreign_key=Operation.use('id').options(ondelete='cascade'))

[docs]    def depart(self):
        """Common logic for final departure step."""
        self.input.update(state='past', reason=self,
                          dt_until=self.dt_execution)

[docs]    def after_insert(self):
        """Either finish right away, or represent the future decrease."""
        self.registry.flush()
        if self.state == 'done':
            self.depart()
        else:
            self.input.dt_until = self.dt_execution

[docs]    def execute_planned(self):
        self.registry.flush()
        self.depart()

[docs]    def cancel_single(self):
        self.reset_inputs_original_values()

[docs]    def obliviate_single(self):
        self.reset_inputs_original_values(state='present')
        self.registry.flush()

[docs]    def input_location_altered(self):
        """A Departure doesn't care if its input changed locations.

        Even if we have in the future Departures that check that the
        input location is a suitable one, they should do it at execution
        time, so that it's still possible to plan a rough Departure from
        any location, that will have to be later refined to be executed.
        """