atg.commerce.order.scheduled
Class ScheduledOrderLookup

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.commerce.order.scheduled.ScheduledOrderLookup

All Implemented Interfaces:

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, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class ScheduledOrderLookup
extends DynamoServlet

This droplet looks up scheduled order items by ID, template ID or profile ID.

input params

id, templateId or profileId

(required)Either the ID, template Id or profile ID used to find the item(s)

siteScope

Optional input parameter to indicate how to narrow the result set when we search by profile ID. The siteScope parameter may be "current", "all", or a shareable type ID such as "atg.ShoppingCart". The siteScope parameter is ignored if the siteIds parameter is specified. If both siteIds and siteScope are omitted, the scope defaults to the value of the configured siteScope property, which defaults to "all".

siteIds

Optional input parameter to indicate how to narrow the result set when we search by profile ID. If specified, the siteIds parameter must be a Collection of Strings.

output parameters

scheduledOrders

a scheduled order repository item array.

oparams

output

rendered once upon successful lookup of items.

empty

rendered once if lookup returns no items

Field Summary

static java.lang.String	ALL
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COUNT_PARAM the name for the count output parameter.
static java.lang.String	CURRENT
static ParameterName	INPUT_PARAM_PROFILE_ID the input parameter name for the itemId parameter
static ParameterName	INPUT_PARAM_SCHEDULE_ITEM_ID the input parameter name for the schdule item id parameter
static ParameterName	INPUT_PARAM_SITEIDS The input parameter that indicates which sites' scheduled orders to get
static ParameterName	INPUT_PARAM_SITESCOPE The input parameter that indicates which shareable type's sites' scheduled orders to get
static ParameterName	INPUT_PARAM_TEMPLATE_ID the input parameter name for the item parameter
protected ScheduledOrderTools	mScheduleOrderTools
protected SiteGroupManager	mSiteGroupManager
static java.lang.String	OPARAM_EMPTY the name for the empty oparam.
static java.lang.String	OPARAM_OUTPUT the name for the output oparam
static java.lang.String	OUTPUT_PARAM_SCHEDULED_ORDERS the name for the scheduledOrders output parameter.

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

ScheduledOrderLookup()

Method Summary

ScheduledOrderTools	getScheduledOrderTools() returns a reference the scheduled order tools
SiteGroupManager	getSiteGroupManager() Returns the SiteGroupManager component
java.lang.String	getSiteScope() gets the property siteScope
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Looks up the scheduled order items in the repository
void	setScheduledOrderTools(ScheduledOrderTools pScheduleOrderTools)
void	setSiteGroupManager(SiteGroupManager pSiteGroupManager) Sets the SiteGroupManager component
void	setSiteScope(java.lang.String pSiteScope) sets the property siteScope.

Methods inherited from class atg.servlet.DynamoServlet

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

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, 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, 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

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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

INPUT_PARAM_SCHEDULE_ITEM_ID

public static final ParameterName INPUT_PARAM_SCHEDULE_ITEM_ID

the input parameter name for the schdule item id parameter

INPUT_PARAM_TEMPLATE_ID

public static final ParameterName INPUT_PARAM_TEMPLATE_ID

the input parameter name for the item parameter

INPUT_PARAM_PROFILE_ID

public static final ParameterName INPUT_PARAM_PROFILE_ID

the input parameter name for the itemId parameter

INPUT_PARAM_SITEIDS

public static final ParameterName INPUT_PARAM_SITEIDS

The input parameter that indicates which sites' scheduled orders to get

INPUT_PARAM_SITESCOPE

public static final ParameterName INPUT_PARAM_SITESCOPE

The input parameter that indicates which shareable type's sites' scheduled orders to get

OPARAM_EMPTY

public static final java.lang.String OPARAM_EMPTY

the name for the empty oparam.

See Also:

Constant Field Values

OPARAM_OUTPUT

public static final java.lang.String OPARAM_OUTPUT

the name for the output oparam

See Also:

Constant Field Values

OUTPUT_PARAM_SCHEDULED_ORDERS

public static final java.lang.String OUTPUT_PARAM_SCHEDULED_ORDERS

the name for the scheduledOrders output parameter. contains a reference to an array of scheduled order repository items

See Also:

Constant Field Values

COUNT_PARAM

public static final java.lang.String COUNT_PARAM

the name for the count output parameter.

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

CURRENT

public static final java.lang.String CURRENT

See Also:

Constant Field Values

mScheduleOrderTools

protected ScheduledOrderTools mScheduleOrderTools

mSiteGroupManager

protected SiteGroupManager mSiteGroupManager

Constructor Detail

ScheduledOrderLookup

public ScheduledOrderLookup()

Method Detail

getScheduledOrderTools

public ScheduledOrderTools getScheduledOrderTools()

returns a reference the scheduled order tools

setScheduledOrderTools

public void setScheduledOrderTools(ScheduledOrderTools pScheduleOrderTools)

setSiteGroupManager

public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)

Sets the SiteGroupManager component

Parameters:

pSiteGroupManager - the SiteGroupManager component. Usually /atg/multisite/SiteGroupManager

getSiteGroupManager

public SiteGroupManager getSiteGroupManager()

Returns the SiteGroupManager component

Returns:

returns property siteGroupManager

setSiteScope

public void setSiteScope(java.lang.String pSiteScope)

sets the property siteScope. This property specifies the default for the siteScope input parameter.

getSiteScope

public java.lang.String getSiteScope()

gets the property siteScope

service

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

Looks up the scheduled order items in the repository

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.

See Also:

ScheduledOrderTools.getScheduledOrderItem(String), ScheduledOrderTools.getScheduledOrderItemsByTemplateId(String), ScheduledOrderTools.getScheduledOrderItemsByProfileId(String)