public class ClaimableLookup
extends atg.servlet.DynamoServlet
Modifier and Type | Field and Description |
---|---|
static atg.nucleus.naming.ParameterName |
CLAIMABLE_ID |
static java.lang.String |
CLAIMABLE_ITEM |
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 |
IS_SUPPORTED |
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 java.lang.String |
MSG_NULL_PAYMENT_GROUP |
static atg.nucleus.naming.ParameterName |
ORDER |
static atg.nucleus.naming.ParameterName |
OUTPUT |
static atg.nucleus.naming.ParameterName |
PAYMENT_GROUP |
static java.lang.String |
REMAINING_AMOUNT |
protected static java.lang.String |
STORE_CREDIT_TYPE |
Constructor and Description |
---|
ClaimableLookup() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getClaimableId()
Deprecated.
|
atg.repository.RepositoryItem |
getClaimableItem(atg.commerce.order.PaymentGroup pPaymentGroup,
atg.commerce.order.Order pOrder)
This method only returns the claimable repository item for the Store Credit and Gift Certificate.
|
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.
|
atg.commerce.order.Order |
getOrder()
Return the Order property.
|
atg.commerce.order.PaymentGroup |
getPaymentGroup()
Deprecated.
in favor of paymentOption
|
java.lang.Object |
getPaymentOption() |
double |
getRemainingAmount(java.lang.Object pPaymentOption,
atg.commerce.order.Order pOrder)
This method only returns the remaining amount for the Store Credit and Gift Certificate.
|
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. |
boolean |
isSupportedPaymentType(java.lang.Object pPaymentOption,
atg.commerce.order.Order pOrder)
This method returns whether the payment group is supported by this droplet.
|
void |
service(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Determines if the given order component is modifiable.
|
void |
setClaimableId(java.lang.String pClaimableId)
Deprecated.
|
void |
setCSRAgentTools(CSRAgentTools pAgentTools)
Sets the cSRAgentTools.
|
void |
setOrder(atg.commerce.order.Order pOrder)
Set the Order property.
|
void |
setPaymentGroup(atg.commerce.order.PaymentGroup pPaymentGroup)
Deprecated.
in favor of paymentOption
|
void |
setPaymentOption(java.lang.Object pPaymentOption) |
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final atg.nucleus.naming.ParameterName CLAIMABLE_ID
public static final atg.nucleus.naming.ParameterName PAYMENT_GROUP
public static final atg.nucleus.naming.ParameterName ORDER
public static final atg.nucleus.naming.ParameterName OUTPUT
public static final atg.nucleus.naming.ParameterName ERROR
public static final java.lang.String CLAIMABLE_ITEM
public static final java.lang.String REMAINING_AMOUNT
public static final java.lang.String IS_SUPPORTED
public static final java.lang.String ERROR_MSG
public static final java.lang.String MSG_NO_CLAIMABLE_ITEM
public static final java.lang.String MSG_NO_CLAIMABLE_ID
public static final java.lang.String MSG_ERROR_WHILE_FETCHING_CLAIMABLE_ITEM
public static final java.lang.String MSG_NULL_PAYMENT_GROUP
protected static final java.lang.String GIFT_CERTIFICATE_TYPE
protected static final java.lang.String STORE_CREDIT_TYPE
public java.lang.Object getPaymentOption()
public void setPaymentOption(java.lang.Object pPaymentOption)
pPaymentOption
- the paymentOption to setpublic atg.commerce.order.PaymentGroup getPaymentGroup()
public void setPaymentGroup(atg.commerce.order.PaymentGroup pPaymentGroup)
pPaymentGroup
- public CSRAgentTools getCSRAgentTools()
public void setCSRAgentTools(CSRAgentTools pAgentTools)
pAgentTools
- public java.lang.String getClaimableId()
public void setClaimableId(java.lang.String pClaimableId)
pClaimableId
- public void setOrder(atg.commerce.order.Order pOrder)
pOrder
- an Order
valuepublic atg.commerce.order.Order getOrder()
Order
valuepublic void service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in class atg.servlet.DynamoServlet
pRequest
- the HTTP requestpResponse
- the HTTP responsejavax.servlet.ServletException
java.io.IOException
public double getRemainingAmount(atg.repository.RepositoryItem pClaimable, java.lang.String pClaimableType)
pClaimable
- the claimable itempClaimableType
- the type of claimablepublic void initializeRequestParameters(atg.servlet.DynamoHttpServletRequest pRequest)
initializeRequestParameters
method gathers the necessary
input parameters and uses them to adjust initialization requirements.pRequest
- a DynamoHttpServletRequest
valuepublic java.lang.Object getInputParameter(atg.servlet.DynamoHttpServletRequest pReq, atg.nucleus.naming.ParameterName pInputParamter)
pReq
- pInputParamter
- public java.lang.String getClaimableType(atg.repository.RepositoryItem pClaimableItem)
pClaimableItem
- public double getRemainingAmount(java.lang.Object pPaymentOption, atg.commerce.order.Order pOrder) throws atg.commerce.CommerceException
pPaymentGroup
- -- This method only fetches the remaining amount for store credit and gift certificate.pOrder
- -- This is provided as an optional parameter. if there is any future need, you may make use of this parameter.atg.commerce.CommerceException
public atg.repository.RepositoryItem getClaimableItem(atg.commerce.order.PaymentGroup pPaymentGroup, atg.commerce.order.Order pOrder) throws atg.commerce.CommerceException
pPaymentGroup
- pOrder
- -- This is provided as an optional parameter. if there is any future need, you may make use of this parameter.atg.commerce.CommerceException
public boolean isSupportedPaymentType(java.lang.Object pPaymentOption, atg.commerce.order.Order pOrder) throws atg.commerce.CommerceException
pPaymentGroup
- pOrder
- atg.commerce.CommerceException