app/soc/logic/models/priority_group.py
author Daniel Hans <Daniel.M.Hans@gmail.com>
Fri, 07 Aug 2009 01:27:24 +0200
changeset 2736 8f3935f0f4ba
parent 2365 a66e1dd8ced7
permissions -rw-r--r--
Argument store added to updateEntityProperties. This argument determines if an entity should be stored in the data model after its properties are updated. It may be useful, for example, along with tasks (Task Queue API). One may want to make some modifications to an entity during execution of a task, but the developer is sure that at least one new task, which also wants to modify the entity, will be queued, so he or she can just update the entity without saving the changes to the data model, set the entity in memcache and the following task (which is to be executed very shortly) is to retrive the current entity from the memcache (without any expensive calls to the actual data model).

#!/usr/bin/python2.5
#
# Copyright 2009 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Priority Group (Model) query functions.
"""

__authors__ = [
  '"Sverre Rabbelier" <sverre@rabbelier.nl>',
  ]


from soc.logic.models import base

import soc.models.priority_group


class Logic(base.Logic):
  """Logic methods for the Priority Group model.
  """

  def __init__(self, model=soc.models.priority_group.PriorityGroup,
               base_model=None, scope_logic=None):
    """Defines the name, key_name and model for this entity.
    """

    # pylint: disable-msg=C0103
    self.EMAIL = 'emails'
    self.CONVERT = 'convert'

    self.groups = {
        self.EMAIL: 'Send out emails',
        self.CONVERT: 'Convert one entity to another type',
        }

    super(Logic, self).__init__(model=model, base_model=base_model,
                                scope_logic=scope_logic)

  def getKeyValuesFromEntity(self, entity):
    """See base.Logic.getKeyValuesFromEntity.
    """

    return [entity.link_id]

  def getKeyValuesFromFields(self, fields):
    """See base.Logic.getKeyValuesFromFields.
    """

    return [fields['link_id']]

  def getKeyFieldNames(self):
    """See base.Logic.getKeyFieldNames.
    """

    return ['link_id']

  def getGroup(self, key_name):
    """Return the specified Priority Group entity.
    """

    if key_name not in self.groups:
      raise base.InvalidArgumentError("Unknown priority group %s." % key_name)

    group = self.getFromKeyName(key_name)

    if not group:
      fields = {
          'link_id': key_name,
          'name': self.groups[key_name],
          'priority': 0,
          }

      group = self.updateOrCreateFromKeyName(fields, key_name)

    return group


logic = Logic()