# -*- coding: iso-8859-1 -*-
#-----------------------------------------------------------------------------
# Modeling Framework: an Object-Relational Bridge for python
#
# Copyright (c) 2001-2004 Sbastien Bigaret <sbigaret@users.sourceforge.net>
# All rights reserved.
#
# This file is part of the Modeling Framework.
#
# This code is distributed under a "3-clause BSD"-style license;
# see the LICENSE file for details.
#-----------------------------------------------------------------------------
"""
FetchSpecification API
CVS Information
$Id: FetchSpecification.py 932 2004-07-20 06:21:57Z sbigaret $
"""
__version__='$Revision: 932 $'[11:-2]
try:
from Interface import Base
except:
class Base:
pass
class IFetchSpecification(Base):
"""
A FetchSpecification gathers all information needed to fetch objects, either
from a database or (in-memory) in an EditingContext.
"""
def __init__(self, entityName, qualifier=None, sortOrderings=(),
distinctFlag=0, deepFlag=0, hints={}):
"Initializes the FetchSpecification"
def distinctFlag(self):
""
def entityName(self):
""
def fetchLimit(self):
"""
Returns the receiver's fetch limit. a zero means that there is no fetch
limit to be applied
"""
def isDeep(self):
""
def locksObjects(self):
"""
Tells whether the FetchSpecification is configured so that fetched objects
will be locked or not
"""
def qualifier(self):
"Returns the qualifier used to fetch objects"
def refreshesRefetchedObjects(self):
""
def setEntityName(self, entityName):
""
def setFetchLimit(self, limit):
""
def setIsDeep(self, aBool):
""
def setLocksObject(self, lockFlag):
"""
Tells the FetchSpecification (actually, objects that will use it) whether
to lock the objects while fetching or not
"""
def setQualifier(self):
"Sets the qualifier used to fetch objects"
def setRefreshesRefetchedObjects(self, aBool):
""
def setSortOrderings(self, sortOrderings):
""
def setUsesDistinct(self, aBool):
""
def sortOrderings(self):
""
def usesDistinct(self):
""
|