com.arsdigita.populate.apps
Interface PopulateApp

All Known Implementing Classes:

AbstractPopulateApp

public interface PopulateApp

Author:

bche

Method Summary

void	createApp(String sTitle, Application parent) Create the application with title, sTitle and parent Application, parent
Application	getApp() Returns the app instance created for populating data
ApplicationType	getAppType() Returns the application type of the app we are creating and populating
String	getArgsDescription() Returns a description of the arguments for populating this application
String	getBaseStringSeed() Gets the BaseStringSeed used in populating data
AppPortlet	getPortlet() Returns a new portlet for the populated application, if appropriate.
void	populateApp(List args) Populates the created app using the arguments in args.
void	setBaseStringSeed(String sSeed) Sets the BaseStringSeed to use in populating data

Method Detail

setBaseStringSeed

public void setBaseStringSeed(String sSeed)

Sets the BaseStringSeed to use in populating data

Parameters:

sSeed - the seed value to use for generating String data in population

getBaseStringSeed

public String getBaseStringSeed()

Gets the BaseStringSeed used in populating data

Returns:

the BaseStringSeed used in populating data

createApp

public void createApp(String sTitle,
                      Application parent)

Create the application with title, sTitle and parent Application, parent

Parameters:

sTitle - the title of the new app to create and populate

parent - the parent application or null if there is none

populateApp

public void populateApp(List args)

Populates the created app using the arguments in args. This method runs in its own transaction

Parameters:

args - the arguments to use in populating the app

getArgsDescription

public String getArgsDescription()

Returns a description of the arguments for populating this application

Returns:

description of the args to PopulateApp()

getApp

public Application getApp()

Returns the app instance created for populating data

getAppType

public ApplicationType getAppType()

Returns the application type of the app we are creating and populating

Returns:

the Application type we are creating and populating

getPortlet

public AppPortlet getPortlet()

Returns a new portlet for the populated application, if appropriate. Otherwise returns null.

Returns:

a new portlet for the populated application, if appropriate. Otherwise returns null.