org.infoglue.cms.applications.tasktool.actions
Class BasicScriptController

java.lang.Object
  org.infoglue.cms.applications.tasktool.actions.BasicScriptController

All Implemented Interfaces:

ScriptController

public class BasicScriptController
extends java.lang.Object
implements ScriptController

This is the script controller interface. This is the entry point for scripts running tasks.

Constructor Summary

BasicScriptController(InfoGluePrincipal infoGluePrincipal)
This is the public constructor which automatically locates the database object.

Method Summary

void	beginTransaction() Begins a transaction on the named database
void	commitTransaction() Ends a transaction on the named database
webwork.action.ActionContext	getActionContext() This method returns the ActionContext for the action
ContentController	getContentController() This is a method to get hold of the SiteNodeVersionController.
ContentVersionController	getContentVersionController() This is a method to get hold of the SiteNodeVersionController.
org.exolab.castor.jdo.Database	getDatabase() This method gets the database for the script
InfoGluePrincipal	getInfoGluePrincipal() Returns the InfoGluePrincipal running the task
java.lang.Integer	getInteger(java.lang.String value) This method returns an Integer from a String.
LanguageController	getLanguageController() This is a method to get hold of the SiteNodeVersionController.
java.lang.Object	getObjectWithName(java.lang.String className) This method instansiate a new object of the given class
java.lang.Object	getOutputParameter(java.lang.String parameter) Gets a parameter for output
RepositoryController	getRepositoryController() This is a method to get hold of the SiteNodeController.
javax.servlet.http.HttpServletRequest	getRequest() A method to set the request for this script
ServiceBindingController	getServiceBindingController() This is a method to get hold of the ServiceBindingController.
SiteNodeController	getSiteNodeController() This is a method to get hold of the SiteNodeController.
SiteNodeVersionController	getSiteNodeVersionController() This is a method to get hold of the SiteNodeVersionController.
boolean	isNull(java.lang.Object object) This method returns true if the object is null - false otherwise.
void	logInfo(java.lang.String info) This is a logmethod used to debug scripts.
void	logInfo(java.lang.String header, boolean info) This is a logmethod used to debug scripts.
void	logInfo(java.lang.String header, int info) This is a logmethod used to debug scripts.
void	logInfo(java.lang.String header, java.lang.Object info) This is a logmethod used to debug scripts.
void	logInfo(java.lang.String header, java.lang.String info) This is a logmethod used to debug scripts.
void	logWarning(java.lang.String info) This is a logmethod used to debug scripts.
void	logWarning(java.lang.String header, boolean info) This is a logmethod used to debug scripts.
void	logWarning(java.lang.String header, int info) This is a logmethod used to debug scripts.
void	logWarning(java.lang.String header, java.lang.Object info) This is a logmethod used to debug scripts.
void	logWarning(java.lang.String header, java.lang.String info) This is a logmethod used to debug scripts.
void	rollbackTransaction() Rollbacks a transaction on the named database
void	setOutputParameter(java.lang.String parameter, java.lang.Object value) Sets a parameter for output later
void	setRequest(javax.servlet.http.HttpServletRequest request) A method to get the request for this script

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicScriptController

public BasicScriptController(InfoGluePrincipal infoGluePrincipal)
                      throws SystemException,
                             java.lang.Exception

This is the public constructor which automatically locates the database object. All scripts are run within it's own transaction for now.

Throws:

SystemException

java.lang.Exception

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

A method to set the request for this script

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

A method to get the request for this script

Specified by:

setRequest in interface ScriptController

getSiteNodeController

public SiteNodeController getSiteNodeController()

This is a method to get hold of the SiteNodeController.

getRepositoryController

public RepositoryController getRepositoryController()

This is a method to get hold of the SiteNodeController.

getServiceBindingController

public ServiceBindingController getServiceBindingController()

This is a method to get hold of the ServiceBindingController.

getSiteNodeVersionController

public SiteNodeVersionController getSiteNodeVersionController()

This is a method to get hold of the SiteNodeVersionController.

getContentController

public ContentController getContentController()

This is a method to get hold of the SiteNodeVersionController.

getContentVersionController

public ContentVersionController getContentVersionController()

This is a method to get hold of the SiteNodeVersionController.

getLanguageController

public LanguageController getLanguageController()

This is a method to get hold of the SiteNodeVersionController.

getInfoGluePrincipal

public InfoGluePrincipal getInfoGluePrincipal()

Returns the InfoGluePrincipal running the task

getInteger

public java.lang.Integer getInteger(java.lang.String value)

This method returns an Integer from a String.

isNull

public boolean isNull(java.lang.Object object)

This method returns true if the object is null - false otherwise.

getActionContext

public webwork.action.ActionContext getActionContext()

This method returns the ActionContext for the action

getObjectWithName

public java.lang.Object getObjectWithName(java.lang.String className)

This method instansiate a new object of the given class

getDatabase

public org.exolab.castor.jdo.Database getDatabase()

This method gets the database for the script

getOutputParameter

public java.lang.Object getOutputParameter(java.lang.String parameter)

Gets a parameter for output

setOutputParameter

public void setOutputParameter(java.lang.String parameter,
                               java.lang.Object value)

Sets a parameter for output later

beginTransaction

public void beginTransaction()
                      throws SystemException

Begins a transaction on the named database

Specified by:

beginTransaction in interface ScriptController

Throws:

SystemException

commitTransaction

public void commitTransaction()
                       throws SystemException

Ends a transaction on the named database

Specified by:

commitTransaction in interface ScriptController

Throws:

SystemException

rollbackTransaction

public void rollbackTransaction()
                         throws SystemException

Rollbacks a transaction on the named database

Throws:

SystemException

logInfo

public void logInfo(java.lang.String info)

This is a logmethod used to debug scripts.

Specified by:

logInfo in interface ScriptController

logInfo

public void logInfo(java.lang.String header,
                    java.lang.String info)

This is a logmethod used to debug scripts.

logInfo

public void logInfo(java.lang.String header,
                    boolean info)

This is a logmethod used to debug scripts.

logInfo

public void logInfo(java.lang.String header,
                    int info)

This is a logmethod used to debug scripts.

logInfo

public void logInfo(java.lang.String header,
                    java.lang.Object info)

This is a logmethod used to debug scripts.

logWarning

public void logWarning(java.lang.String info)

This is a logmethod used to debug scripts.

logWarning

public void logWarning(java.lang.String header,
                       java.lang.String info)

This is a logmethod used to debug scripts.

logWarning

public void logWarning(java.lang.String header,
                       boolean info)

This is a logmethod used to debug scripts.

logWarning

public void logWarning(java.lang.String header,
                       int info)

This is a logmethod used to debug scripts.

logWarning

public void logWarning(java.lang.String header,
                       java.lang.Object info)

This is a logmethod used to debug scripts.