|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.framework.GearConfigFormHandler
public class GearConfigFormHandler
The GearConfigFormHandler is intended for use with instanceConfig, installConfig, initialConfig, and userConfig gear pages. Each gear should make its own Nucleus component for this form handler rather than sharing with another gear.
Properties:
For an example please see the reference gears.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
GearConfigFormHandler()
|
Method Summary | |
---|---|
void |
addFailureMessage(java.lang.String pResourceBundle,
java.lang.String pMsgId,
java.lang.String[] pArgs)
Set a form processing error message that should be visible to the user. |
void |
addSuccessMessage(java.lang.String pResourceBundle,
java.lang.String pMsgId,
java.lang.String[] pArgs)
Set a form processing info message that should be visible to the user. |
void |
beforeGet(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Calls super.beforeGet() and then enables the transactional form handler management features with setEnsureTransaction(true). |
java.lang.String |
getCancelUrl()
|
java.lang.String |
getCommunityIdRequestParameter()
|
java.lang.String |
getFailureUrl()
|
java.lang.String |
getGearDefIdRequestParameter()
|
protected GearEnvironment |
getGearEnvironment(DynamoHttpServletRequest pReq,
DynamoHttpServletResponse pResp)
sets up the gear environment. |
java.lang.String |
getGearIdRequestParameter()
|
java.lang.String |
getParamNames()
Returns a space delimited list of the names of the gear params that will be set in this form |
java.lang.String |
getParamType()
choices are instance (default) or user |
java.lang.String |
getSuccessUrl()
|
java.util.Map |
getValues()
|
boolean |
handleCancel(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Cancel. |
boolean |
handleCollectValues(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method is intended for collecting the values from the form into the value map. |
boolean |
handleConfirm(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Take the values from the value property and set them into the gear environment user or instance parameters. |
boolean |
handleInitializeDefaultValues(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
|
boolean |
handleParamNames(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
initialize the default values of the values map property by getting the parameter values out of the gear environment |
boolean |
isSettingDefaultValues()
if true, then we are setting default values of the gear definition parameters |
boolean |
isSettingUserParams()
convenience method to determine if we are setting user params or instance params |
void |
postCollectValues(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Override this method to do any post-processing. |
void |
postConfirm(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Override this method to do any post-processing. |
void |
preCollectValues(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Override this method to do any pre-processing or verification of form input. |
void |
preConfirm(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Override this method to do any pre-processing or verification of form input. |
void |
setCancelUrl(java.lang.String s)
|
void |
setCommunityIdRequestParameter(java.lang.String pCommunityIdRequestParameter)
|
void |
setFailureUrl(java.lang.String s)
|
void |
setGearDefIdRequestParameter(java.lang.String pGearDefIdRequestParameter)
|
void |
setGearIdRequestParameter(java.lang.String pGearIdRequestParameter)
|
void |
setInitializeDefaultValues(java.lang.String s)
|
void |
setParamNames(java.lang.String pParamNames)
Sets a space delimited list of the names of the gear params that will be set in this form |
void |
setParamType(java.lang.String pParamType)
choices are instance (default) or user |
void |
setSettingDefaultValues(boolean pSettingDefaultValues)
set property to true to set default values of the gear definition parameters |
void |
setSuccessUrl(java.lang.String s)
|
void |
setValues(java.util.Map pValues)
|
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet |
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, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GearConfigFormHandler()
Method Detail |
---|
public void setParamType(java.lang.String pParamType)
public java.lang.String getParamType()
public void setSettingDefaultValues(boolean pSettingDefaultValues)
public boolean isSettingDefaultValues()
public void setValues(java.util.Map pValues)
public java.util.Map getValues()
public void setGearIdRequestParameter(java.lang.String pGearIdRequestParameter)
public java.lang.String getGearIdRequestParameter()
public void setCommunityIdRequestParameter(java.lang.String pCommunityIdRequestParameter)
public java.lang.String getCommunityIdRequestParameter()
public void setGearDefIdRequestParameter(java.lang.String pGearDefIdRequestParameter)
public java.lang.String getGearDefIdRequestParameter()
public void beforeGet(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
beforeGet
in interface DropletFormHandler
beforeGet
in class EmptyFormHandler
public boolean handleCollectValues(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean handleCancel(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
handleCancel
in class GenericFormHandler
javax.servlet.ServletException
java.io.IOException
public boolean handleConfirm(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void preConfirm(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void postConfirm(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void preCollectValues(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void postCollectValues(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void setParamNames(java.lang.String pParamNames)
public java.lang.String getParamNames()
public boolean handleParamNames(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
protected GearEnvironment getGearEnvironment(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pResp)
public java.lang.String getSuccessUrl()
public void setSuccessUrl(java.lang.String s)
public java.lang.String getFailureUrl()
public void setFailureUrl(java.lang.String s)
public java.lang.String getCancelUrl()
public void setCancelUrl(java.lang.String s)
public boolean handleInitializeDefaultValues(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void setInitializeDefaultValues(java.lang.String s)
public void addFailureMessage(java.lang.String pResourceBundle, java.lang.String pMsgId, java.lang.String[] pArgs) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public void addSuccessMessage(java.lang.String pResourceBundle, java.lang.String pMsgId, java.lang.String[] pArgs) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean isSettingUserParams()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |