atg.rview
Class RelationalViewDroplet

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.TimedOperationService
              atg.nucleus.servlet.ServletService
                  atg.nucleus.servlet.HttpServletService
                      atg.servlet.DynamoServlet
                          atg.rview.RelationalViewDroplet

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class RelationalViewDroplet
extends DynamoServlet

The RelationalViewDroplet will perform one of the select operations on a RelationalView, place the result into the result parameter, then render the output parameter. It takes the following parameters:

rviewName

The name of the RelationalView to access

rview

The instance of RelationalView to access - this may be specified in place of rviewName

subviewName

The name of the subview of rviewName to access. Not required if no subview is being accessed.

subviewParam0, subviewParam1, ...

The parameters to the subview, only required if the subviewName is specified, and the subview requires parameters.

operation

May be either "select", "selectFirst", "selectCount", or "selectExists". Default is "select". The value of the result parameter depends on the type of operation selected:

• select - the result parameter will contain an array of the resulting rows, suitable for use in a ForEach droplet
• selectFirst - the result parameter will contain a single row. If no row is returned, then the output parameter is not called.
• selectCount - the result parameter will contain an Integer of the number of rows in the subview.
• selectExists - the result parameter will contain a Boolean indicating if there are any rows in the subview.

firstRow

If the operation is select, then this optional parameter will indicate how many rows to skip before starting the array of results.

rowCount

If the operation is select, then this optional parameter will indicate the maximum number of rows to be placed in the array of results.

functionName

The droplet may also call a query function in place of a subview. If this is specified, then subviewName/subviewParam.../operation are not required. In this case, the function is called, and the resulting array is placed into the result parameter.

functionParam0, functionParam1, ...

If functionName is used, and the function requires parameters, then these parameters must be defined here.

resultName

Normally the result of the RelationalView operation is placed into a parameter called result. If resultName is specified, then the result will be placed into the parameter named by resultName.

output

This is rendered after the RelationalView operation has been completed, and the result has been placed into the result parameter (or parameter named by resultName.

errorOutput

This is rendered if an error occurs while running the droplet. The error message will be placed into the errorMessage parameter.

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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

RelationalViewDroplet()
Constructor

Method Summary

int	getIntParameter(DynamoHttpServletRequest pRequest, java.lang.String pParamName, int pDefaultValue) Returns the int value of the given parameter, or the default value if not defined.
RelationalViewManager	getRelationalViewManager()
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Service method
void	setRelationalViewManager(RelationalViewManager pRelationalViewManager)

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, init, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

RelationalViewDroplet

public RelationalViewDroplet()

Constructor

Method Detail

getRelationalViewManager

public RelationalViewManager getRelationalViewManager()

setRelationalViewManager

public void setRelationalViewManager(RelationalViewManager pRelationalViewManager)

service

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

Service method

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

getIntParameter

public int getIntParameter(DynamoHttpServletRequest pRequest,
                           java.lang.String pParamName,
                           int pDefaultValue)

Returns the int value of the given parameter, or the default value if not defined.