#!/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.

"""Timeline (Model) query functions.

"""

__authors__ = [

  '"Sverre Rabbelier" <sverre@rabbelier.nl>',

  ]

from soc.logic.models import base

import soc.models.timeline

class Logic(base.Logic):

  """Logic methods for the Timeline model.

  """

  def __init__(self, model=soc.models.timeline.Timeline,

               base_model=None, scope_logic=None):

    """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 getScopeDepth(self):

    """See base.Logic.getScopeDepth.

    """

    return 3

  def getKeyValues(self, entity):

    """See base.Logic.getKeyNameValues.

    """

    return [entity.scope_path]

  def getKeyValuesFromFields(self, fields):

    """See base.Logic.getKeyValuesFromFields.

    """

    return [fields['scope_path']]

  def getKeyFieldNames(self):

    """See base.Logic.getKeyFieldNames.

    """

    return ['scope_path']

logic = Logic()