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 2008 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.
"""Document (Model) query functions.
"""
__authors__ = [
'"Sverre Rabbelier" <sverre@rabbelier.nl>',
]
from soc.cache import sidebar
from soc.cache import home
from soc.logic.models import work
from soc.logic.models import linkable as linkable_logic
import soc.models.document
import soc.models.work
class Logic(work.Logic):
"""Logic methods for the Document model
"""
def __init__(self, model=soc.models.document.Document,
base_model=soc.models.work.Work, scope_logic=linkable_logic):
"""Defines the name, key_name and model for this entity.
"""
super(Logic, self).__init__(model=model, base_model=base_model,
scope_logic=scope_logic)
def getKeyValuesFromEntity(self, entity):
"""See base.Logic.getKeyNameValues.
"""
return [entity.prefix, entity.scope_path, entity.link_id]
def getKeyValuesFromFields(self, fields):
"""See base.Logic.getKeyValuesFromFields.
"""
return [fields['prefix'], fields['scope_path'], fields['link_id']]
def getKeyFieldNames(self):
"""See base.Logic.getKeyFieldNames.
"""
return ['prefix', 'scope_path', 'link_id']
def isDeletable(self, entity):
"""See base.Logic.isDeletable.
"""
return not entity.home_for
def _updateField(self, entity, entity_properties, name):
"""Special logic for Document.
- Flush the sidebar when a document is featured.
- Remove the document from the homepage cache when the home_for is updated
"""
value = entity_properties[name]
if (name == 'is_featured') and (entity.is_featured != value):
sidebar.flush()
home_for = entity.home_for
if (name != 'home_for') and home_for:
home.flush(home_for)
return True
logic = Logic()