atg.commerce.csr.order
Class ClaimableLookup

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.csr.order.ClaimableLookup

All Implemented Interfaces:

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

public class ClaimableLookup
extends atg.servlet.DynamoServlet

This droplet takes the claimable id and provides the clamable item and its related information

Field Summary

static atg.nucleus.naming.ParameterName	CLAIMABLE_ID
static java.lang.String	CLAIMABLE_ITEM
static java.lang.String	CLAIMABLE_TYPE
static java.lang.String	CLASS_VERSION
static atg.nucleus.naming.ParameterName	ERROR
static java.lang.String	ERROR_MSG
protected static java.lang.String	GIFT_CERTIFICATE_TYPE
static java.lang.String	MSG_ERROR_WHILE_FETCHING_CLAIMABLE_ITEM
static java.lang.String	MSG_NO_CLAIMABLE_ID
static java.lang.String	MSG_NO_CLAIMABLE_ITEM
static atg.nucleus.naming.ParameterName	OUTPUT
static java.lang.String	REMAINING_AMOUNT
protected static java.lang.String	STORE_CREDIT_TYPE

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

ClaimableLookup()

Method Summary

java.lang.String	getClaimableId() Returns the claimableId.
java.lang.String	getClaimableType(atg.repository.RepositoryItem pClaimableItem) Given the claimable item, this gets the claimable type as store credit or gift certificate.
CSRAgentTools	getCSRAgentTools() Returns the cSRAgentTools.
java.lang.Object	getInputParameter(atg.servlet.DynamoHttpServletRequest pReq, atg.nucleus.naming.ParameterName pInputParamter) Gets the input parameter values.
double	getRemainingAmount(atg.repository.RepositoryItem pClaimable, java.lang.String pClaimableType) Returns the remaining amount for the claimable
void	initializeRequestParameters(atg.servlet.DynamoHttpServletRequest pRequest) The initializeRequestParameters method gathers the necessary input parameters and uses them to adjust initialization requirements.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Determines if the given order component is modifiable.
void	setClaimableId(java.lang.String pClaimableId) Sets the claimableId.
void	setCSRAgentTools(CSRAgentTools pAgentTools) Sets the cSRAgentTools.

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 java.lang.String CLASS_VERSION

CLAIMABLE_ID

public static final atg.nucleus.naming.ParameterName CLAIMABLE_ID

OUTPUT

public static final atg.nucleus.naming.ParameterName OUTPUT

ERROR

public static final atg.nucleus.naming.ParameterName ERROR

CLAIMABLE_ITEM

public static final java.lang.String CLAIMABLE_ITEM

See Also:

Constant Field Values

REMAINING_AMOUNT

public static final java.lang.String REMAINING_AMOUNT

See Also:

Constant Field Values

CLAIMABLE_TYPE

public static final java.lang.String CLAIMABLE_TYPE

See Also:

Constant Field Values

ERROR_MSG

public static final java.lang.String ERROR_MSG

See Also:

Constant Field Values

MSG_NO_CLAIMABLE_ITEM

public static final java.lang.String MSG_NO_CLAIMABLE_ITEM

See Also:

Constant Field Values

MSG_NO_CLAIMABLE_ID

public static final java.lang.String MSG_NO_CLAIMABLE_ID

See Also:

Constant Field Values

MSG_ERROR_WHILE_FETCHING_CLAIMABLE_ITEM

public static final java.lang.String MSG_ERROR_WHILE_FETCHING_CLAIMABLE_ITEM

See Also:

Constant Field Values

GIFT_CERTIFICATE_TYPE

protected static final java.lang.String GIFT_CERTIFICATE_TYPE

See Also:

Constant Field Values

STORE_CREDIT_TYPE

protected static final java.lang.String STORE_CREDIT_TYPE

See Also:

Constant Field Values

Constructor Detail

ClaimableLookup

public ClaimableLookup()

Method Detail

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns the cSRAgentTools.

Returns:

cSRAgentTools

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pAgentTools)

Sets the cSRAgentTools.

Parameters:

pAgentTools -

getClaimableId

public java.lang.String getClaimableId()

Returns the claimableId.

Returns:

claimableId

setClaimableId

public void setClaimableId(java.lang.String pClaimableId)

Sets the claimableId.

Parameters:

pClaimableId -

service

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

Determines if the given order component is modifiable. Renders the appropriate open parameters.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - the HTTP request

pResponse - the HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

getRemainingAmount

public double getRemainingAmount(atg.repository.RepositoryItem pClaimable,
                                 java.lang.String pClaimableType)

Returns the remaining amount for the claimable

Parameters:

pCreditCard - the credit card

Returns:

double the maximum amount that can be credited to this credit card

initializeRequestParameters

public void initializeRequestParameters(atg.servlet.DynamoHttpServletRequest pRequest)

The initializeRequestParameters method gathers the necessary input parameters and uses them to adjust initialization requirements.

Parameters:

pRequest - a DynamoHttpServletRequest value

getInputParameter

public java.lang.Object getInputParameter(atg.servlet.DynamoHttpServletRequest pReq,
                                          atg.nucleus.naming.ParameterName pInputParamter)

Gets the input parameter values.

Parameters:

DynamoHttpServletRequest -

String -

Returns:

Input paramter value

getClaimableType

public java.lang.String getClaimableType(atg.repository.RepositoryItem pClaimableItem)

Given the claimable item, this gets the claimable type as store credit or gift certificate.

Parameters:

pClaimableItem -

Returns: