com.arsdigita.populate.cms
Class PopulateFolders

java.lang.Object
  extended bycom.arsdigita.populate.cms.PopulateFolders

public class PopulateFolders
extends Object

Author:
bche

Constructor Summary
PopulateFolders()
           
 
Method Summary
 String getBaseStringSeed()
           
 com.arsdigita.populate.cms.FolderList getFolders()
          Retruns an unordered list of all the folders populated.
 void popuate(int iFolders, com.arsdigita.cms.ContentSection section)
          Populates iFolders under the root folder of the content section, section
 void populate(int iTopFolders, int iFolderDepth, com.arsdigita.cms.ContentSection section)
          Populates iTopFolders * iFolderDepth folders in the content section, section.
 void setBaseStringSeed(String sSeed)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PopulateFolders

public PopulateFolders()
Method Detail

setBaseStringSeed

public void setBaseStringSeed(String sSeed)

getBaseStringSeed

public String getBaseStringSeed()

popuate

public void popuate(int iFolders,
                    com.arsdigita.cms.ContentSection section)
             throws IllegalArgumentException
Populates iFolders under the root folder of the content section, section

Parameters:
iFolders - the number of folders to create. Must be >= 0
section - the content section in which to populate folders
Throws:
IllegalArgumentException

populate

public void populate(int iTopFolders,
                     int iFolderDepth,
                     com.arsdigita.cms.ContentSection section)
              throws IllegalArgumentException
Populates iTopFolders * iFolderDepth folders in the content section, section. For example, if you specify iTopFolders=5 and iFolderDepth=3, then you will create 5 folders directly under the root folder. Each of these 5 top-level folders will contain a sub-folder, and a sub-folder of that sub-folder, for a total depth of 3 folders.

Parameters:
iFolderDepth - the number of levels to nest folders. Must be >=1.
section - the conten section in which to populate folders
Throws:
IllegalArgumentException

getFolders

public com.arsdigita.populate.cms.FolderList getFolders()
Retruns an unordered list of all the folders populated.

Returns:
an unordered list of all the folders populated


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 22 2004:0022 UTC