[Erp5-report] r6868 - /erp5/trunk/products/ERP5/Interface/
nobody at svn.erp5.org
nobody at svn.erp5.org
Mon Apr 24 10:43:06 CEST 2006
Author: vincent
Date: Mon Apr 24 10:43:04 2006
New Revision: 6868
URL: http://svn.erp5.org?rev=6868&view=rev
Log:
Improve coding style.
Improve docstrings.
Modified:
erp5/trunk/products/ERP5/Interface/Coordinate.py
erp5/trunk/products/ERP5/Interface/Entity.py
erp5/trunk/products/ERP5/Interface/Variated.py
Modified: erp5/trunk/products/ERP5/Interface/Coordinate.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/Interface/Coordinate.py?rev=6868&r1=6867&r2=6868&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/Interface/Coordinate.py (original)
+++ erp5/trunk/products/ERP5/Interface/Coordinate.py Mon Apr 24 10:43:04 2006
@@ -27,31 +27,31 @@
##############################################################################
try:
- from Interface import Interface
+ from Interface import Interface
except ImportError:
- # for Zope versions before 2.6.0
- from Interface import Base as Interface
+ # for Zope versions before 2.6.0
+ from Interface import Base as Interface
class Coordinate(Interface):
+ """
+ Common Interface for all Coordinate objects
+ """
+
+ def asText():
"""
- Common Interface for all Coordinate objects
+ returns the coordinate as a text string
"""
+ pass
- def asText():
- """
- returns the coordinate as a text string
- """
- pass
+ def fromText(coordinate_text):
+ """
+ modifies the coordinate according to the input text
+ """
+ pass
- def fromText(coordinate_text):
- """
- modifies the coordinate according to the input text
- """
- pass
-
- def standardTextFormat():
- """
- returns a string which defines the standard
- string format for that coordinate
- """
- pass
+ def standardTextFormat():
+ """
+ returns a string which defines the standard
+ string format for that coordinate
+ """
+ pass
Modified: erp5/trunk/products/ERP5/Interface/Entity.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/Interface/Entity.py?rev=6868&r1=6867&r2=6868&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/Interface/Entity.py (original)
+++ erp5/trunk/products/ERP5/Interface/Entity.py Mon Apr 24 10:43:04 2006
@@ -27,86 +27,85 @@
##############################################################################
try:
- from Interface import Interface
+ from Interface import Interface
except ImportError:
- # for Zope versions before 2.6.0
- from Interface import Base as Interface
+ # for Zope versions before 2.6.0
+ from Interface import Base as Interface
class Entity(Interface):
+ """
+ Common Interface for Entity objects
+ """
+
+ def getDefaultAddress():
"""
- Common Interface for Entity objects
+ Returns the default address as a text string
"""
+ pass
- def getDefaultAddress():
- """
- Returns the default address as a text string
- """
- pass
+ def getDefaultAddressStreetAddress():
+ """
+ Returns the default address street as a text string
+ """
+ pass
- def getDefaultAddressStreetAddress():
- """
- Returns the default address street as a text string
- """
- pass
+ def getDefaultAddressCity():
+ """
+ Returns the default address city as a text string
+ """
+ pass
- def getDefaultAddressCity():
- """
- Returns the default address city as a text string
- """
- pass
+ def getDefaultAddressRegion():
+ """
+ Returns the default address region as a text string
+ """
+ pass
- def getDefaultAddressRegion():
- """
- Returns the default address region as a text string
- """
- pass
+ def getDefaultAddressZipCode():
+ """
+ Returns the default address zip code as a text string
+ """
+ pass
- def getDefaultAddressZipCode():
- """
- Returns the default address zip code as a text string
- """
- pass
+ def getDefaultTelephone():
+ """
+ Returns the default telephone as a text string
+ """
+ pass
- def getDefaultTelephone():
- """
- Returns the default telephone as a text string
- """
- pass
+ def getDefaultFax():
+ """
+ Returns the default fax as a text string
+ """
+ pass
- def getDefaultFax():
- """
- Returns the default fax as a text string
- """
- pass
+ def getDefaultEmail():
+ """
+ Returns the default email as a text string
+ """
+ pass
- def getDefaultEmail():
- """
- Returns the default email as a text string
- """
- pass
+ def setDefaultAddress(coordinate):
+ """
+ Updates the default address from a standard text string
+ """
+ pass
- def setDefaultAddress(coordinate):
- """
- Updates the default address from a standard text string
- """
- pass
+ def setDefaultTelephone(coordinate):
+ """
+ Updates the default telephone from a standard text string
+ """
+ pass
- def setDefaultTelephone(coordinate):
- """
- Updates the default telephone from a standard text string
- """
- pass
+ def setDefaultFax(coordinate):
+ """
+ Updates the default fax from a standard text string
+ """
+ pass
- def setDefaultFax(coordinate):
- """
- Updates the default fax from a standard text string
- """
- pass
+ def setDefaultEmail(coordinate):
+ """
+ Updates the default email from a standard text string
+ """
+ pass
- def setDefaultEmail(coordinate):
- """
- Updates the default email from a standard text string
- """
- pass
-
-
Modified: erp5/trunk/products/ERP5/Interface/Variated.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/Interface/Variated.py?rev=6868&r1=6867&r2=6868&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/Interface/Variated.py (original)
+++ erp5/trunk/products/ERP5/Interface/Variated.py Mon Apr 24 10:43:04 2006
@@ -27,123 +27,126 @@
##############################################################################
try:
- from Interface import Interface
+ from Interface import Interface
except ImportError:
- # for Zope versions before 2.6.0
- from Interface import Base as Interface
+ # for Zope versions before 2.6.0
+ from Interface import Base as Interface
class Variated(Interface):
+ """
+ Common Interface for all objects which can be
+ variated.
+ """
+
+ # The following methods are intended to access to the
+ # variation value of a variated object. Discrete variations
+ # are based on categories. General variations are encapsulated
+ # into VariationValue instances.
+
+ # Discrete Variation accessors
+ def getVariationCategoryList():
"""
- Common Interface for all objects which can be
- variated.
+ returns a list or relative URLs which defines
+ a discrete variation (ie. a list of category
+ memberships)
"""
+ pass
- # The following methods are intended to access to the
- # variation value of a variated object. Discrete variations
- # are based on categories. General variations are encapsulated
- # into VariationValue instances.
+ def _setVariationCategoryList(node_list):
+ """
+ modifies the discrete variation of an
+ variated instance by providing a list
+ of relative URLs
+ """
+ pass
- # Discrete Variation accessors
- def getVariationCategoryList():
- """
- returns a list or relative URLs which defines
- a discrete variation (ie. a list of category
- memberships)
- """
- pass
+ def setVariationCategoryList(node_list):
+ """
+ modifies the discrete variation of an
+ variated instance by providing a list
+ of relative URLs
- def _setVariationCategoryList(node_list):
- """
- modifies the discrete variation of an
- variated instance by providing a list
- of relative URLs
- """
- pass
+ reindexes the object
+ """
+ pass
- def setVariationCategoryList(node_list):
- """
- modifies the discrete variation of an
- variated instance by providing a list
- of relative URLs
+ def getVariationBaseCategoryList(node_list):
+ """
+ returns a list of base category ids
+ which are used to define discrete variations
+ for this instance
+ """
+ pass
- reindexes the object
- """
- pass
+ def _setVariationBaseCategoryList(node_list):
+ """
+ modifies the list of base category ids
+ which are used to define discrete variations
+ for this instance
+ """
+ pass
- def getVariationBaseCategoryList(node_list):
- """
- returns a list of base category ids
- which are used to define discrete variations
- for this instance
- """
- pass
+ def setVariationBaseCategoryList(node_list):
+ """
+ modifies the list of base category ids
+ which are used to define discrete variations
+ for this instance
+ """
+ pass
- def _setVariationBaseCategoryList(node_list):
- """
- modifies the list of base category ids
- which are used to define discrete variations
- for this instance
- """
- pass
+ # General Variation accessors
+ def getVariationValue():
+ """
+ Returns a VariationValue object.
+ """
+ pass
- def setVariationBaseCategoryList(node_list):
- """
- modifies the list of base category ids
- which are used to define discrete variations
- for this instance
- """
- pass
+ def _setVariationValue(value):
+ """
+ Private setter for VariationValue.
+ """
+ pass
- # General Variation accessors
- def getVariationValue():
- """
- """
- pass
-
- def _setVariationValue(value):
- """
- """
- pass
-
- def setVariationValue(value):
- """
- """
- pass
+ def setVariationValue(value):
+ """
+ Sets the VariationValue.
+ """
+ pass
- # The following methods are intended to access the
- # variation range of a variated object. A Variation range can
- # be defined in a Resource instance or in any object
- # which has a relation with a Resource (Amount, Transformation)
+ # The following methods are intended to access the
+ # variation range of a variated object. A Variation range can
+ # be defined in a Resource instance or in any object
+ # which has a relation with a Resource (Amount, Transformation)
- # Discrete Variation Range accessors
+ # Discrete Variation Range accessors
- def getVariationRangeCategoryList(base_category_list=(), base=1):
- """
- returns a list of categories which are acceptable
- as discrete variation values
- """
- pass
+ def getVariationRangeCategoryList(base_category_list=(), base=1):
+ """
+ returns a list of categories which are acceptable
+ as discrete variation values
+ """
+ pass
- def getVariationRangeCategoryItemList(base_category_list=(),
- display_id='getTitle', base=1, current_category=None):
- """
- returns a list of (category.id, category.display_id()) which are acceptable
- as discrete variation values
- """
- pass
+ def getVariationRangeCategoryItemList(base_category_list=(),
+ display_id='getTitle', base=1, current_category=None):
+ """
+ returns a list of (category.id, category.display_id()) which are acceptable
+ as discrete variation values
+ """
+ pass
- def getVariationRangeBaseCategoryList(base_category_list=(), base=1):
- """
- returns a list of base categories which are acceptable
- as discrete variation values
- """
- pass
+ def getVariationRangeBaseCategoryList(base_category_list=(), base=1):
+ """
+ returns a list of base categories which are acceptable
+ as discrete variation values
+ """
+ pass
- def getVariationRangeBaseCategoryItemList(base_category_list=(),
- display_id='getTitle', base=1, current_category=None):
- """
- returns a list of base category items which are acceptable
- as discrete variation values
- """
- pass
+ def getVariationRangeBaseCategoryItemList(base_category_list=(),
+ display_id='getTitle', base=1, current_category=None):
+ """
+ returns a list of base category items which are acceptable
+ as discrete variation values
+ """
+ pass
More information about the Erp5-report
mailing list