"""

        model = self.model

        # define the base query

        query = session.query(model.Person)\

                       .options(orm.joinedload(model.Person.phones))

        # does search term look like a phone number?

        phone_term = self.get_phone_search_term(term)

        if phone_term:

            # yep, so just search for the phone number

            query = query.join(model.PersonPhoneNumber,

                               model.PersonPhoneNumber.parent_uuid == model.Person.uuid)

            query = query.filter(sa.func.regexp_replace(model.PersonPhoneNumber.number,

                                                        r'\D', '', 'g')\

                                 .like('%{}%'.format(phone_term)))

        else: # term does not look like a phone number

            # so just search by name

            criteria = [model.Person.display_name.ilike('%{}%'.format(word))

                        for word in term.split()]

            query = query.filter(sa.and_(*criteria))

        # oh, and sort by something useful

        query = query.order_by(model.Person.display_name)

        # generate result list from query

        results = []

        for person in query:

            phone = person.first_phone()

            if phone:

                label = "{} {}".format(person.display_name, phone.number)

            else:

                label = person.display_name

            results.append({'value': person.uuid,

                            'label': label,

                            'display': person.display_name})

        return results

    def get_customer_info(self, batch, **kwargs):

        """

        Return a data dict containing misc. info pertaining to the

        customer/person for the order batch.

        """

        info = {

            'customer_uuid': None,

            'person_uuid': None,

            'phone_number': None,

            'email_address': None,

        }

        if batch.customer:

            info['customer_uuid'] = batch.customer.uuid

            phone = batch.customer.first_phone()

            if phone:

                info['phone_number'] = phone.number

            email = batch.customer.first_email()

            if email:

                info['email_address'] = email.address

        if batch.person:

            info['person_uuid'] = batch.person.uuid

            if not info['phone_number']:

                phone = batch.person.first_phone()

                if phone:

                    info['phone_number'] = phone.number

                email = batch.person.first_email()

                if email:

                    info['email_address'] = email.address

        return info

    def custom_product_autocomplete(self, session, term, **kwargs):

        """

        For the given term, this should return a (possibly empty) list

        of products which "match" the term.  Each element in the list

        should be a dict with "label" and "value" keys.

        """

        raise NotImplementedError("Please define the "

                                  "{}.custom_product_autocomplete() "

                                  "method.".format(__class__.__name__))

    def refresh_row(self, row):

        if not row.product:

            if row.item_entry:

                session = orm.object_session(row)

                # TODO: should do more than just query for uuid here

                product = session.query(model.Product).get(row.item_entry)

                if product:

                    row.product = product

            if not row.product:

                row.status_code = row.STATUS_PRODUCT_NOT_FOUND

                return

        product = row.product

        row.product_upc = product.upc

        row.product_brand = six.text_type(product.brand or "")

        row.product_description = product.description

        row.product_size = product.size

        row.product_weighed = product.weighed

        row.case_quantity = self.get_case_size_for_product(product)

        department = product.department

        row.department_number = department.number if department else None

        row.department_name = department.name if department else None

        cost = product.cost

        row.product_unit_cost = cost.unit_cost if cost else None

        regprice = product.regular_price

        row.unit_price = regprice.price if regprice else None

        # we need to know if total price is updated

        old_total = row.total_price

        # maybe update total price

        if row.unit_price is None:

            row.total_price = None

        elif not row.unit_price:

            row.total_price = 0

        else:

            row.total_price = row.unit_price * row.order_quantity

            if row.order_uom == self.enum.UNIT_OF_MEASURE_CASE:

                row.total_price *= (row.case_quantity or 1)

        # update total price for batch too, if it changed

        if row.total_price != old_total:

            batch = row.batch

            batch.total_price = ((batch.total_price or 0)

                                 + (row.total_price or 0)

                                 - (old_total or 0))

        row.status_code = row.STATUS_OK

    def remove_row(self, row):

        batch = row.batch

        if not row.removed:

            row.removed = True

            if row.total_price:

                batch.total_price = (batch.total_price or 0) - row.total_price

        self.refresh_batch_status(batch)

    def execute(self, batch, user=None, progress=None, **kwargs):

        """

        Default behavior here will simply create a new (proper) Customer Order

        based on the batch contents.  Override as needed.

        """

        batch_fields = [

            'store',

            'id',

            'customer',

            'person',

            'phone_number',

            'email_address',

            'total_price',

        ]

        order = model.CustomerOrder()

        order.created_by = user

        order.status_code = self.enum.CUSTORDER_STATUS_ORDERED

        for field in batch_fields:

            setattr(order, field, getattr(batch, field))

        row_fields = [

            'product',

            'product_upc',

            'product_brand',

            'product_description',

            'product_size',

            'product_weighed',

            'department_number',

            'department_name',

            'case_quantity',

            'order_quantity',

            'order_uom',

            'product_unit_cost',

            'unit_price',

            'discount_percent',

            'total_price',

            'paid_amount',

            'payment_transaction_number',

        ]

        def convert(row, i):

            item = model.CustomerOrderItem()

            item.sequence = i

            for field in row_fields:

                setattr(item, field, getattr(row, field))

            order.items.append(item)

        self.progress_loop(convert, batch.active_rows(), progress,

                           message="Converting batch rows to order items")

        session = orm.object_session(batch)

        session.add(order)

        session.flush()

        return order

# -*- coding: utf-8; -*-

################################################################################

#

#  Rattail -- Retail Software Framework

#  Copyright © 2010-2021 Lance Edgar

#

#  This file is part of Rattail.

#

#  Rattail is free software: you can redistribute it and/or modify it under the

#  terms of the GNU General Public License as published by the Free Software

#  Foundation, either version 3 of the License, or (at your option) any later

#  version.

#

#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY

#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more

#  details.

#

#  You should have received a copy of the GNU General Public License along with

#  Rattail.  If not, see <http://www.gnu.org/licenses/>.

#

################################################################################

"""

**Enumerations**

The following enumerations are provided:

.. attribute:: BATCH_ACTION

   Action types for use with batches.  These are taken from the SIL

   specification.

.. attribute:: EMAIL_PREFERENCE

   Various options indicating a person's preferences on whether to receive

   email, and if so, in what format.

.. attribute:: EMPLOYEE_STATUS

   Status types for employees (e.g. current, former).

.. attribute:: PHONE_TYPE

   Various "types" of phone contact information (e.g. home, work).

.. attribute:: PRICE_TYPE

   Various types of prices which may exist for a product.  These are taken from

   the SIL specification.

.. attribute:: UNIT_OF_MEASURE

   Units of measure for use with products (e.g. each, pound).  These are taken

   from the SIL specification.

"""

from __future__ import unicode_literals, absolute_import

BATCH_ACTION_ADD                = 'ADD'

BATCH_ACTION_ADD_REPLACE        = 'ADDRPL'

BATCH_ACTION_CHANGE             = 'CHANGE'

BATCH_ACTION_LOAD               = 'LOAD'

BATCH_ACTION_REMOVE             = 'REMOVE'

BATCH_ACTION = {

    BATCH_ACTION_ADD            : "Add",

    BATCH_ACTION_ADD_REPLACE    : "Add/Replace",

    BATCH_ACTION_CHANGE         : "Change",

    BATCH_ACTION_LOAD           : "Load",

    BATCH_ACTION_REMOVE         : "Remove",

    }

CUSTORDER_BATCH_MODE_CREATING            = 10

CUSTORDER_BATCH_MODE_GATHERING           = 20

CUSTORDER_BATCH_MODE = {

    CUSTORDER_BATCH_MODE_CREATING        : "creating",

    CUSTORDER_BATCH_MODE_GATHERING       : "gathering",

}

CUSTORDER_STATUS_ORDERED                = 10

# CUSTORDER_STATUS_PAID                   = 20

CUSTORDER_STATUS = {

    CUSTORDER_STATUS_ORDERED            : "ordered",

    # CUSTORDER_STATUS_PAID               : "paid",

}

EMAIL_ATTEMPT_CREATED           = 0

EMAIL_ATTEMPT_SUCCESS           = 1

EMAIL_ATTEMPT_FAILURE           = 2

# EMAIL_ATTEMPT_BOUNCED           = 3

EMAIL_ATTEMPT = {

    EMAIL_ATTEMPT_CREATED       : "created",

    EMAIL_ATTEMPT_SUCCESS       : "success",

    EMAIL_ATTEMPT_FAILURE       : "failure",

    # EMAIL_ATTEMPT_BOUNCED       : "bounced",

}

EMAIL_PREFERENCE_NONE           = 0

EMAIL_PREFERENCE_TEXT           = 1

EMAIL_PREFERENCE_HTML           = 2

EMAIL_PREFERENCE_MOBILE         = 3

EMAIL_PREFERENCE = {

    EMAIL_PREFERENCE_NONE       : "No Emails",

    EMAIL_PREFERENCE_TEXT       : "Text",

    EMAIL_PREFERENCE_HTML       : "HTML",

    EMAIL_PREFERENCE_MOBILE     : "Mobile",

    }

HANDHELD_DEVICE_TYPE_MOTOROLA           = 'motorola'

HANDHELD_DEVICE_TYPE_PALMOS             = 'palmos'

HANDHELD_DEVICE_TYPE = {

    HANDHELD_DEVICE_TYPE_MOTOROLA       : "Motorola",

    HANDHELD_DEVICE_TYPE_PALMOS         : "PalmOS",

}

IMPORTER_BATCH_ROW_STATUS_NOCHANGE      = 0

IMPORTER_BATCH_ROW_STATUS_CREATE        = 1

IMPORTER_BATCH_ROW_STATUS_UPDATE        = 2

IMPORTER_BATCH_ROW_STATUS_DELETE        = 3

IMPORTER_BATCH_ROW_STATUS = {

    IMPORTER_BATCH_ROW_STATUS_NOCHANGE  : "no change",

    IMPORTER_BATCH_ROW_STATUS_CREATE    : "create",

    IMPORTER_BATCH_ROW_STATUS_UPDATE    : "update",

    IMPORTER_BATCH_ROW_STATUS_DELETE    : "delete",

}

INVENTORY_MODE_REPLACE          = 1

INVENTORY_MODE_REPLACE_ADJUST   = 2

INVENTORY_MODE_ADJUST           = 3

INVENTORY_MODE_ZERO_ALL         = 4

INVENTORY_MODE_VARIANCE         = 5

INVENTORY_MODE = {

    INVENTORY_MODE_REPLACE              : "Replace only",

    INVENTORY_MODE_REPLACE_ADJUST       : "Replace then adjust",

    INVENTORY_MODE_ADJUST               : "Adjust only",

    INVENTORY_MODE_ZERO_ALL             : "Zero all",

    INVENTORY_MODE_VARIANCE             : "Variance Correction",

}

MESSAGE_STATUS_INBOX            = 1

MESSAGE_STATUS_ARCHIVE          = 2

MESSAGE_STATUS = {

    MESSAGE_STATUS_INBOX        : "Inbox",

    MESSAGE_STATUS_ARCHIVE      : "Archive",

}

PHONE_TYPE_HOME                 = 'home'

PHONE_TYPE_MOBILE               = 'mobile'

PHONE_TYPE_OTHER                = 'other'

PHONE_TYPE = {

    PHONE_TYPE_HOME             : "Home",

    PHONE_TYPE_MOBILE           : "Mobile",

    PHONE_TYPE_OTHER            : "Other",

    }

PRICE_TYPE_REGULAR              = 0

PRICE_TYPE_TPR                  = 1

PRICE_TYPE_SALE                 = 2

PRICE_TYPE_MANAGER_SPECIAL      = 3

PRICE_TYPE_ALTERNATE            = 4

PRICE_TYPE_FREQUENT_SHOPPER     = 5

PRICE_TYPE_MFR_SUGGESTED        = 901

PRICE_TYPE = {

    PRICE_TYPE_REGULAR          : "Regular Price",

    PRICE_TYPE_TPR              : "TPR",

    PRICE_TYPE_SALE             : "Sale",

    PRICE_TYPE_MANAGER_SPECIAL  : "Manager Special",

    PRICE_TYPE_ALTERNATE        : "Alternate Price",

    PRICE_TYPE_FREQUENT_SHOPPER : "Frequent Shopper",

    PRICE_TYPE_MFR_SUGGESTED    : "Manufacturer's Suggested",

    }

PURCHASE_BATCH_MODE_ORDERING            = 10

PURCHASE_BATCH_MODE_RECEIVING           = 20

PURCHASE_BATCH_MODE_COSTING             = 30

PURCHASE_BATCH_MODE = {

    PURCHASE_BATCH_MODE_ORDERING        : "ordering",

    PURCHASE_BATCH_MODE_RECEIVING       : "receiving",

    PURCHASE_BATCH_MODE_COSTING         : "invoicing",

}

PURCHASE_CREDIT_STATUS_NEW              = 10

PURCHASE_CREDIT_STATUS_SUBMITTED        = 20

PURCHASE_CREDIT_STATUS_SATISFIED        = 30

PURCHASE_CREDIT_STATUS_NONCREDITABLE    = 40

PURCHASE_CREDIT_STATUS = {

    PURCHASE_CREDIT_STATUS_NEW          : "new",

    PURCHASE_CREDIT_STATUS_SUBMITTED    : "submitted",

    PURCHASE_CREDIT_STATUS_SATISFIED    : "satisfied",

    PURCHASE_CREDIT_STATUS_NONCREDITABLE: "non-creditable",

}

PURCHASE_STATUS_NEW             = 1 # TODO: is this needed?

PURCHASE_STATUS_ORDERED         = 10

PURCHASE_STATUS_RECEIVED        = 20

PURCHASE_STATUS_COSTED          = 30

PURCHASE_STATUS_PAID            = 40

PURCHASE_STATUS = {

    PURCHASE_STATUS_NEW         : "new/pending",

    PURCHASE_STATUS_ORDERED     : "ordered",

    PURCHASE_STATUS_RECEIVED    : "received",

    PURCHASE_STATUS_COSTED      : "invoiced",

    PURCHASE_STATUS_PAID        : "paid",

}

TEMPMON_APPLIANCE_TYPE_COOLER           = 1

TEMPMON_APPLIANCE_TYPE_FREEZER          = 2

TEMPMON_APPLIANCE_TYPE = {

    TEMPMON_APPLIANCE_TYPE_COOLER       : "cooler",

    TEMPMON_APPLIANCE_TYPE_FREEZER      : "freezer",

}

TEMPMON_DISK_TYPE_SDCARD                = 1

TEMPMON_DISK_TYPE_USB                   = 2

TEMPMON_DISK_TYPE = {

    TEMPMON_DISK_TYPE_SDCARD            : "SD card",

    TEMPMON_DISK_TYPE_USB               : "USB",

}

TEMPMON_PROBE_STATUS_GOOD_TEMP          = 1

TEMPMON_PROBE_STATUS_LOW_TEMP           = 2

TEMPMON_PROBE_STATUS_HIGH_TEMP          = 3

TEMPMON_PROBE_STATUS_CRITICAL_HIGH_TEMP = 4

# TODO: deprecate / remove this one

TEMPMON_PROBE_STATUS_CRITICAL_TEMP      = TEMPMON_PROBE_STATUS_CRITICAL_HIGH_TEMP

TEMPMON_PROBE_STATUS_ERROR              = 5

TEMPMON_PROBE_STATUS_CRITICAL_LOW_TEMP  = 6

TEMPMON_PROBE_STATUS = {

    TEMPMON_PROBE_STATUS_CRITICAL_HIGH_TEMP     : "critical high temp",

    # TODO: deprecate / remove this one

    TEMPMON_PROBE_STATUS_CRITICAL_TEMP          : "critical high temp",

    TEMPMON_PROBE_STATUS_HIGH_TEMP              : "high temp",

    TEMPMON_PROBE_STATUS_GOOD_TEMP              : "good temp",

    TEMPMON_PROBE_STATUS_LOW_TEMP               : "low temp",

    TEMPMON_PROBE_STATUS_CRITICAL_LOW_TEMP      : "critical low temp",

    TEMPMON_PROBE_STATUS_ERROR                  : "error",

}

# These values are taken from the SIL standard.

UNIT_OF_MEASURE_NONE                    = '00'

UNIT_OF_MEASURE_EACH                    = '01'

UNIT_OF_MEASURE_10_COUNT                = '02'

UNIT_OF_MEASURE_DOZEN                   = '03'

UNIT_OF_MEASURE_50_COUNT                = '04'

UNIT_OF_MEASURE_100_COUNT               = '05'

UNIT_OF_MEASURE_100_COUNT_1_PLY         = '06'

UNIT_OF_MEASURE_100_COUNT_2_PLY         = '07'

UNIT_OF_MEASURE_100_COUNT_3_PLY         = '08'