atg.commerce.fulfillment
Class ShippableGroupsDroplet

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.fulfillment.ShippableGroupsDroplet

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 ShippableGroupsDroplet
extends DynamoServlet

This droplet finds all the orders with shipping groups in a pending shipment state. It takes no parameters and has two OPARAMs. The first is shipSchedule. This shows the information of the HardgoodShipper scheduled service, include the current time, the time of the last run, and the schedule. The next OPARAM contains two lists. One is the list of order ids associated with each shipping group in the other list, which is a list of shipping group ids that are in a PENDING_SHIPMENT state. The count of items is also returned. Both lists are the same length. The last oparam ("empty") gets rendered if there are no shippable groups. Shipper
Current Time = NA
Last Run = NA
Schedule = NA
no orderId, no shippingGroupId
There are no shippable groups.
The error parameter gets set to any error that occurs.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	DEFAULT_ORDER_STATE_PROPERTY
static java.lang.String	DEFAULT_SHIPPING_GROUP_ORDER_PROPERTY
static java.lang.String	DEFAULT_SHIPPING_GROUP_SHIP_ON_DATE_PROPERTY
static java.lang.String	DEFAULT_SHIPPING_GROUP_STATE_PROPERTY
static java.lang.String	DEFAULT_SHIPPING_GROUP_SUBMITTED_DATE_PROPERTY
static java.lang.String	DEFAULT_SHIPPING_GROUP_VIEW_NAME

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

ShippableGroupsDroplet()

Method Summary

HardgoodShipper	getHardgoodShipper()
Repository	getOrderRepository()
java.lang.String	getOrderStatePropertyName() The name of the state property in the order
OrderStates	getOrderStates() The class containing state information for orders
java.lang.String	getShippingGroupOrderPropertyName() The name of the order property in the shipping group
java.lang.String	getShippingGroupShipOnDatePropertyName() The name of the property in ShippingGroups that specifies when a shipping group should be shipped.
java.lang.String	getShippingGroupStatePropertyName() The name of the state property for ShippingGroups
ShippingGroupStates	getShippingGroupStates() The object containing all the states of an shipping group
java.lang.String	getShippingGroupSubmittedDatePropertyName() The name of the property for ShippingGroups that says when it was submitted.
java.lang.String	getShippingGroupViewName() The name of the view in the order repository for shipping groups.
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
void	setHardgoodShipper(HardgoodShipper pHardgoodShipper)
void	setOrderRepository(Repository pOrderRepository)
void	setOrderStatePropertyName(java.lang.String pOrderStatePropertyName)
void	setOrderStates(OrderStates pOrderStates)
void	setShippingGroupOrderPropertyName(java.lang.String pShippingGroupOrderPropertyName)
void	setShippingGroupShipOnDatePropertyName(java.lang.String pShippingGroupShipOnDatePropertyName)
void	setShippingGroupStatePropertyName(java.lang.String pShippingGroupStatePropertyName)
void	setShippingGroupStates(ShippingGroupStates pShippingGroupStates)
void	setShippingGroupSubmittedDatePropertyName(java.lang.String pShippingGroupSubmittedDatePropertyName)
void	setShippingGroupViewName(java.lang.String pShippingGroupViewName)

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

Class version string

See Also:

Constant Field Values

DEFAULT_SHIPPING_GROUP_ORDER_PROPERTY

public static final java.lang.String DEFAULT_SHIPPING_GROUP_ORDER_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHIPPING_GROUP_STATE_PROPERTY

public static final java.lang.String DEFAULT_SHIPPING_GROUP_STATE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHIPPING_GROUP_SHIP_ON_DATE_PROPERTY

public static final java.lang.String DEFAULT_SHIPPING_GROUP_SHIP_ON_DATE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHIPPING_GROUP_SUBMITTED_DATE_PROPERTY

public static final java.lang.String DEFAULT_SHIPPING_GROUP_SUBMITTED_DATE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHIPPING_GROUP_VIEW_NAME

public static final java.lang.String DEFAULT_SHIPPING_GROUP_VIEW_NAME

See Also:

Constant Field Values

DEFAULT_ORDER_STATE_PROPERTY

public static final java.lang.String DEFAULT_ORDER_STATE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

ShippableGroupsDroplet

public ShippableGroupsDroplet()

Method Detail

setShippingGroupStates

public void setShippingGroupStates(ShippingGroupStates pShippingGroupStates)

getShippingGroupStates

public ShippingGroupStates getShippingGroupStates()

The object containing all the states of an shipping group

setOrderStates

public void setOrderStates(OrderStates pOrderStates)

getOrderStates

public OrderStates getOrderStates()

The class containing state information for orders

setShippingGroupOrderPropertyName

public void setShippingGroupOrderPropertyName(java.lang.String pShippingGroupOrderPropertyName)

getShippingGroupOrderPropertyName

public java.lang.String getShippingGroupOrderPropertyName()

The name of the order property in the shipping group

setShippingGroupStatePropertyName

public void setShippingGroupStatePropertyName(java.lang.String pShippingGroupStatePropertyName)

getShippingGroupStatePropertyName

public java.lang.String getShippingGroupStatePropertyName()

The name of the state property for ShippingGroups

setShippingGroupShipOnDatePropertyName

public void setShippingGroupShipOnDatePropertyName(java.lang.String pShippingGroupShipOnDatePropertyName)

getShippingGroupShipOnDatePropertyName

public java.lang.String getShippingGroupShipOnDatePropertyName()

The name of the property in ShippingGroups that specifies when a shipping group should be shipped.

setShippingGroupSubmittedDatePropertyName

public void setShippingGroupSubmittedDatePropertyName(java.lang.String pShippingGroupSubmittedDatePropertyName)

getShippingGroupSubmittedDatePropertyName

public java.lang.String getShippingGroupSubmittedDatePropertyName()

The name of the property for ShippingGroups that says when it was submitted.

setShippingGroupViewName

public void setShippingGroupViewName(java.lang.String pShippingGroupViewName)

getShippingGroupViewName

public java.lang.String getShippingGroupViewName()

The name of the view in the order repository for shipping groups. (The ItemDescriptor name)

setOrderStatePropertyName

public void setOrderStatePropertyName(java.lang.String pOrderStatePropertyName)

getOrderStatePropertyName

public java.lang.String getOrderStatePropertyName()

The name of the state property in the order

setHardgoodShipper

public void setHardgoodShipper(HardgoodShipper pHardgoodShipper)

getHardgoodShipper

public HardgoodShipper getHardgoodShipper()

setOrderRepository

public void setOrderRepository(Repository pOrderRepository)

getOrderRepository

public Repository getOrderRepository()

service

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

Description copied from class: DynamoServlet

This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".

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.