summaryrefslogtreecommitdiff
path: root/addons/base_status
diff options
context:
space:
mode:
authorThibault Delavallée <tde@openerp.com>2013-07-19 12:04:11 +0200
committerThibault Delavallée <tde@openerp.com>2013-07-19 12:04:11 +0200
commitc63c20e0667bcba22bb6b80b613a7b4e366b472b (patch)
tree765c45c603d73bfac756028fca816d56c23ca49e /addons/base_status
parent163d88ea3277a8bc1d7db217c0e01c5273ba8235 (diff)
[REM] Removed base_stage. One last part of 'generic case management' goes away from OpenERP.
bzr revid: tde@openerp.com-20130719100411-59dx6c7wi6n3gf00
Diffstat (limited to 'addons/base_status')
-rw-r--r--addons/base_status/__init__.py1
-rw-r--r--addons/base_status/__openerp__.py5
-rw-r--r--addons/base_status/base_stage.py264
3 files changed, 2 insertions, 268 deletions
diff --git a/addons/base_status/__init__.py b/addons/base_status/__init__.py
index e4107f90a37..ea9d738e614 100644
--- a/addons/base_status/__init__.py
+++ b/addons/base_status/__init__.py
@@ -20,6 +20,5 @@
##############################################################################
import base_state
-import base_stage
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
diff --git a/addons/base_status/__openerp__.py b/addons/base_status/__openerp__.py
index 79b6dd2016c..b3936ec10cb 100644
--- a/addons/base_status/__openerp__.py
+++ b/addons/base_status/__openerp__.py
@@ -24,11 +24,10 @@
'version': '1.0',
'category': 'Hidden',
'description': """
-This module handles state and stage. It is derived from the crm_base and crm_case classes from crm.
-===================================================================================================
+This module handles state. It is derived from the crm_base and crm_case classes from crm.
+==========================================================================================
* ``base_state``: state management
- * ``base_stage``: stage management
""",
'author': 'OpenERP SA',
'website': 'http://www.openerp.com',
diff --git a/addons/base_status/base_stage.py b/addons/base_status/base_stage.py
deleted file mode 100644
index edf9db166af..00000000000
--- a/addons/base_status/base_stage.py
+++ /dev/null
@@ -1,264 +0,0 @@
-# -*- coding: utf-8 -*-
-##############################################################################
-#
-# OpenERP, Open Source Management Solution
-# Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program 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 Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
-##############################################################################
-
-from openerp.osv import fields, osv
-from openerp.tools.translate import _
-
-class base_stage(object):
- """ Base utility mixin class for objects willing to manage their stages.
- Object that inherit from this class should inherit from mailgate.thread
- to have access to the mail gateway, as well as Chatter. Objects
- subclassing this class should define the following colums:
- - ``date_open`` (datetime field)
- - ``date_closed`` (datetime field)
- - ``user_id`` (many2one to res.users)
- - ``partner_id`` (many2one to res.partner)
- - ``stage_id`` (many2one to a stage definition model)
- - ``state`` (selection field, related to the stage_id.state)
- """
-
- def _get_default_partner(self, cr, uid, context=None):
- """ Gives id of partner for current user
- :param context: if portal not in context returns False
- """
- if context is None:
- context = {}
- if context.get('portal'):
- user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
- return user.partner_id.id
- return False
-
- def _get_default_email(self, cr, uid, context=None):
- """ Gives default email address for current user
- :param context: if portal not in context returns False
- """
- if context is None:
- context = {}
- if context.get('portal'):
- user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
- return user.email
- return False
-
- def _get_default_user(self, cr, uid, context=None):
- """ Gives current user id
- :param context: if portal not in context returns False
- """
- if context is None:
- context = {}
- if not context or context.get('portal'):
- return False
- return uid
-
- def onchange_partner_address_id(self, cr, uid, ids, add, email=False, context=None):
- """ This function returns value of partner email based on Partner Address
- :param add: Id of Partner's address
- :param email: Partner's email ID
- """
- data = {'value': {'email_from': False, 'phone':False}}
- if add:
- address = self.pool.get('res.partner').browse(cr, uid, add)
- data['value'] = {'partner_name': address and address.name or False,
- 'email_from': address and address.email or False,
- 'phone': address and address.phone or False,
- 'street': address and address.street or False,
- 'street2': address and address.street2 or False,
- 'city': address and address.city or False,
- 'state_id': address.state_id and address.state_id.id or False,
- 'zip': address and address.zip or False,
- 'country_id': address.country_id and address.country_id.id or False,
- }
- fields = self.fields_get(cr, uid, context=context or {})
- for key in data['value'].keys():
- if key not in fields:
- del data['value'][key]
- return data
-
- def onchange_partner_id(self, cr, uid, ids, part, email=False):
- """ This function returns value of partner address based on partner
- :param part: Partner's id
- :param email: Partner's email ID
- """
- data={}
- if part:
- addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact'])
- data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value'])
- return {'value': data}
-
- def _get_default_section_id(self, cr, uid, context=None):
- """ Gives default section """
- return False
-
- def _get_default_stage_id(self, cr, uid, context=None):
- """ Gives default stage_id """
- return self.stage_find(cr, uid, [], None, [('state', '=', 'draft')], context=context)
-
- def stage_find(self, cr, uid, cases, section_id, domain=[], order='sequence', context=None):
- """ Find stage, with a given (optional) domain on the search,
- ordered by the order parameter. If several stages match the
- search criterions, the first one will be returned, according
- to the requested search order.
- This method is meant to be overriden by subclasses. That way
- specific behaviors can be achieved for every class inheriting
- from base_stage.
-
- :param cases: browse_record of cases
- :param section_id: section limitating the search, given for
- a generic search (for example default search).
- A section models concepts such as Sales team
- (for CRM), ou departments (for HR).
- :param domain: a domain on the search of stages
- :param order: order of the search
- """
- return False
-
- def stage_set_with_state_name(self, cr, uid, cases, state_name, context=None):
- """ Set a new stage, with a state_name instead of a stage_id
- :param cases: browse_record of cases
- """
- if isinstance(cases, (int, long)):
- cases = self.browse(cr, uid, cases, context=context)
- for case in cases:
- stage_id = self.stage_find(cr, uid, [case], None, [('state', '=', state_name)], context=context)
- if stage_id:
- self.stage_set(cr, uid, [case.id], stage_id, context=context)
- return True
-
- def stage_set(self, cr, uid, ids, stage_id, context=None):
- """ Set the new stage. This methods is the right method to call
- when changing states. It also checks whether an onchange is
- defined, and execute it.
- """
- value = {}
- if hasattr(self, 'onchange_stage_id'):
- value = self.onchange_stage_id(cr, uid, ids, stage_id, context=context)['value']
- value['stage_id'] = stage_id
- return self.write(cr, uid, ids, value, context=context)
-
- def stage_change(self, cr, uid, ids, op, order, context=None):
- """ Change the stage and take the next one, based on a condition
- writen for the 'sequence' field and an operator. This methods
- checks whether the case has a current stage, and takes its
- sequence. Otherwise, a default 0 sequence is chosen and this
- method will therefore choose the first available stage.
- For example if op is '>' and current stage has a sequence of
- 10, this will call stage_find, with [('sequence', '>', '10')].
- """
- for case in self.browse(cr, uid, ids, context=context):
- seq = 0
- if case.stage_id:
- seq = case.stage_id.sequence or 0
- section_id = None
- next_stage_id = self.stage_find(cr, uid, [case], None, [('sequence', op, seq)],order, context=context)
- if next_stage_id:
- return self.stage_set(cr, uid, [case.id], next_stage_id, context=context)
- return False
-
- def stage_next(self, cr, uid, ids, context=None):
- """ This function computes next stage for case from its current stage
- using available stage for that case type
- """
- return self.stage_change(cr, uid, ids, '>','sequence', context)
-
- def stage_previous(self, cr, uid, ids, context=None):
- """ This function computes previous stage for case from its current
- stage using available stage for that case type
- """
- return self.stage_change(cr, uid, ids, '<', 'sequence desc', context)
-
- def copy(self, cr, uid, id, default=None, context=None):
- """ Overrides orm copy method to avoid copying messages,
- as well as date_closed and date_open columns if they
- exist."""
- if default is None:
- default = {}
-
- if hasattr(self, '_columns'):
- if self._columns.get('date_closed'):
- default.update({ 'date_closed': False, })
- if self._columns.get('date_open'):
- default.update({ 'date_open': False })
- return super(base_stage, self).copy(cr, uid, id, default, context=context)
-
- def case_escalate(self, cr, uid, ids, context=None):
- """ Escalates case to parent level """
- for case in self.browse(cr, uid, ids, context=context):
- data = {'active': True}
- if case.section_id.parent_id:
- data['section_id'] = case.section_id.parent_id.id
- if case.section_id.parent_id.change_responsible:
- if case.section_id.parent_id.user_id:
- data['user_id'] = case.section_id.parent_id.user_id.id
- else:
- raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
- self.write(cr, uid, [case.id], data, context=context)
- return True
-
- def case_open(self, cr, uid, ids, context=None):
- """ Opens case """
- cases = self.browse(cr, uid, ids, context=context)
- for case in cases:
- data = {'active': True}
- if not case.user_id:
- data['user_id'] = uid
- self.case_set(cr, uid, [case.id], 'open', data, context=context)
- return True
-
- def case_close(self, cr, uid, ids, context=None):
- """ Closes case """
- return self.case_set(cr, uid, ids, 'done', {'active': True, 'date_closed': fields.datetime.now()}, context=context)
-
- def case_cancel(self, cr, uid, ids, context=None):
- """ Cancels case """
- return self.case_set(cr, uid, ids, 'cancel', {'active': True}, context=context)
-
- def case_pending(self, cr, uid, ids, context=None):
- """ Set case as pending """
- return self.case_set(cr, uid, ids, 'pending', {'active': True}, context=context)
-
- def case_reset(self, cr, uid, ids, context=None):
- """ Resets case as draft """
- return self.case_set(cr, uid, ids, 'draft', {'active': True}, context=context)
-
- def case_set(self, cr, uid, ids, new_state_name=None, values_to_update=None, new_stage_id=None, context=None):
- """ Generic method for setting case. This methods wraps the update
- of the record.
-
- :params new_state_name: the new state of the record; this method
- will call ``stage_set_with_state_name``
- that will find the stage matching the
- new state, using the ``stage_find`` method.
- :params new_stage_id: alternatively, you may directly give the
- new stage of the record
- :params state_name: the new value of the state, such as
- 'draft' or 'close'.
- :params update_values: values that will be added with the state
- update when writing values to the record.
- """
- cases = self.browse(cr, uid, ids, context=context)
- # 1. update the stage
- if new_state_name:
- self.stage_set_with_state_name(cr, uid, cases, new_state_name, context=context)
- elif not (new_stage_id is None):
- self.stage_set(cr, uid, ids, new_stage_id, context=context)
- # 2. update values
- if values_to_update:
- self.write(cr, uid, ids, values_to_update, context=context)
- return True