atg.portal.admin

Class FolderFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.droplet.TransactionalFormHandler

atg.portal.admin.PortalGenericFormHandler

atg.portal.admin.FolderFormHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class FolderFormHandler
extends PortalGenericFormHandler

This class provides convenient form handling methods for operating on the current the Portal Application Framework folders. It can be used to create new or edit existing folders (Community, Gear Definition, etc.)

Folder management is the core functionality of this form handler. It controls creating, updating and deleting all folders using calls to the business layer PortalRepositoryManagement class. This functionality is invoked via the various handleXXX methods of the form handler.

All handle methods in this form handler mirror a similiar pattern. Each handleXXX process, some have an associated preXXX and postXXX method. For example, the handleDone has an associate preCreateFolder and postCreateFolder. These pre/post methods provide an easy way for customer's to extend the functionality of this form handler.

See Also:

GenericFormHandler, PortalGenericFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected static java.util.ResourceBundle	sResourceBundle Resource Bundle

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
FolderFormHandler()

Method Summary

Modifier and Type	Method and Description
boolean	createFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) createFolder is called by the handlers to make calls to the management layer class to create a folder using the properties set by the form.
boolean	deleteFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) deleteFolder is called by the handlers to make calls to the management layer class to delete a folder.
java.lang.String	getFolderItemDescriptor() Returns property FolderItemDescriptor.
java.lang.String	getFolderName()
java.lang.String	getFolderURL()
java.lang.String	getParentFolder() Returns property ParentFolder.
boolean	handleCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called when the user submits the form using the Create button to create a single folder.
boolean	handleDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to handle deleting a folder.
void	postCreateFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
void	postDeleteFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
boolean	preCreateFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started.
void	preDeleteFolder(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started
void	setFolderItemDescriptor(java.lang.String pFolderItemDescriptor) Sets property FolderItemDescriptor
void	setFolderName(java.lang.String pFolderName) Sets property folderName
void	setFolderURL(java.lang.String pFolderURL) Sets property folderURL
void	setParentFolder(java.lang.String pParentFolder) Sets property ParentFolder

Methods inherited from class atg.portal.admin.PortalGenericFormHandler

addFormException, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getDefaultLocale, getFailureMessageProcessor, getFailureURL, getFormError, getFormInfo, getFormMessages, getLocale, getPublisher, getSuccessMessageProcessor, getSuccessURL, getUserLocale, handleResetFormExceptions, handleResetFormMessages, handleSetLocale, isUseRequestLocale, processException, processException, processException, processException, processSuccess, processSuccess, processSuccess, resetFormMessages, sendAlertMessage, setDefaultLocale, setFailureMessageProcessor, setFailureURL, setPublisher, setSuccessMessageProcessor, setSuccessURL, setUseRequestLocale

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

FolderFormHandler

public FolderFormHandler()

Method Detail

setFolderName

public void setFolderName(java.lang.String pFolderName)

Sets property folderName

Parameters:

pFolderName - The property to store the value of folderName.

getFolderName

public java.lang.String getFolderName()

setFolderURL

public void setFolderURL(java.lang.String pFolderURL)

Sets property folderURL

Parameters:

pFolderURL - The property to store the value of folderURL.

getFolderURL

public java.lang.String getFolderURL()

setParentFolder

public void setParentFolder(java.lang.String pParentFolder)

Sets property ParentFolder

Parameters:

pParentFolder - The property to store the value of ParentFolder.

getParentFolder

public java.lang.String getParentFolder()

Returns property ParentFolder.

Returns:

The value of the mParentFolder.

setFolderItemDescriptor

public void setFolderItemDescriptor(java.lang.String pFolderItemDescriptor)

Sets property FolderItemDescriptor

Parameters:

pFolderItemDescriptor - The property to store the value of FolderItemDescriptor.

getFolderItemDescriptor

public java.lang.String getFolderItemDescriptor()

Returns property FolderItemDescriptor.

Returns:

The value of the mFolderItemDescriptor.

handleCreate

public boolean handleCreate(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException,
                            PortalException

Called when the user submits the form using the Create button to create a single folder.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

PortalException

createFolder

public boolean createFolder(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException,
                            PortalException

createFolder is called by the handlers to make calls to the management layer class to create a folder using the properties set by the form.

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

PortalException

preCreateFolder

public boolean preCreateFolder(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

Operation called just before component creation is started.

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postCreateFolder

public void postCreateFolder(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Operation called just component creation is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

handleDelete

public boolean handleDelete(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Called to handle deleting a folder.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

deleteFolder

public boolean deleteFolder(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

deleteFolder is called by the handlers to make calls to the management layer class to delete a folder.

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

preDeleteFolder

public void preDeleteFolder(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Operation called just before component creation is started

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postDeleteFolder

public void postDeleteFolder(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Operation called just component creation is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong