==================
Naming Conventions
==================

:Revision: $Id: naming-conventions.txt 31276 2006-01-03 16:36:21Z dkuhlman $

.. sectnum::    :depth: 4
.. contents::   :depth: 4


Method Names
------------

- Methods that return information about pre-defined portal objects 
  are called 'listXYZ'

  e.g. 'listPortalStyles()' ...


- Methods that return contextual information, folder content, etc.
  are called 'getXYZ'

  e.g. 'getPageBlocks()'


- Methods that require a search, an advanced algorithm, etc. 
  are called 'findXYZ'

  e.g. 'findOrphanedStyles', 'findIdenticalStyles' ...


.. Emacs
.. Local Variables:
.. mode: rst
.. End:
.. Vim
.. vim: set filetype=rst:

