atg.commerce.order.purchase
Class PaymentGroupContainerService

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.commerce.order.purchase.PaymentGroupContainerService
All Implemented Interfaces:
CommerceIdentifierPaymentInfoContainer, PaymentGroupMapContainer, 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, java.io.Serializable, java.util.EventListener

public class PaymentGroupContainerService
extends GenericService
implements PaymentGroupMapContainer, CommerceIdentifierPaymentInfoContainer

The PaymentGroupContainerService is convenient designed for a session scoped component. This implements both the PaymentGroupMapContainer and the CommerceIdentifierPaymentInfoContainer interfaces. This service is responsible for keeping track of both the user's authorized PaymentGroups, as well as the CommerceIdentifierPaymentInfo objects for a user's Order.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
 
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
PaymentGroupContainerService()
          Creates a new PaymentGroupContainerService instance.
 
Method Summary
 void addCommerceIdentifierPaymentInfo(java.lang.String pCommerceIdentifierId, CommerceIdentifierPaymentInfo pCommerceIdentifierPaymentInfo)
          The addCommerceIdentifierPaymentInfo method adds the supplied CommerceIdentifierId and CommerceIdentifierPaymentInfo to the Map.
 void addPaymentGroup(java.lang.String pPaymentGroupName, PaymentGroup pPaymentGroup)
          The addPaymentGroup method adds the supplied payment name and PaymentGroup to the Map.
 java.util.List getAllCommerceIdentifierPaymentInfos()
          The getAllCommerceIdentifierPaymentInfos method returns one List of all CommerceIdentifierPaymentInfos in the entire Map.
 java.util.Map getCommerceIdentifierPaymentInfoMap()
          Return the CommerceIdentifierPaymentInfoMap property.
 java.util.List getCommerceIdentifierPaymentInfos(java.lang.String pCommerceIdentifierId)
          The getCommerceIdentifierPaymentInfos method returns the List of CommerceIdentifierPaymentInfos corresponding to the supplied CommerceIdentifierId.
 java.lang.String getDefaultPaymentGroupName()
          Return the DefaultPaymentGroupName property.
 PaymentGroup getPaymentGroup(java.lang.String pPaymentGroupName)
          The getPaymentGroup method returns the PaymentGroup corresponding to the supplied payment name.
 java.util.Map getPaymentGroupMap()
          Return the PaymentGroupMap property.
 void removeAllCommerceIdentifierPaymentInfos()
          The removeAllCommerceIdentifierPaymentInfos method clears the Map.
 void removeAllPaymentGroups()
          The removeAllPaymentGroups method clears the Map.
 void removeCommerceIdentifierPaymentInfos(java.lang.String pCommerceIdentifierId)
          The removeCommerceIdentifierPaymentInfos method removes the CommerceIdentifierPaymentInfo corresponding to the supplied CommerceIdentifierId.
 void removePaymentGroup(java.lang.String pPaymentGroupName)
          The removePaymentGroup method removes the PaymentGroup corresponding to the supplied payment name.
 void setCommerceIdentifierPaymentInfoMap(java.util.Map pCommerceIdentifierPaymentInfoMap)
          Set the CommerceIdentifierPaymentInfoMap property.
 void setDefaultPaymentGroupName(java.lang.String pDefaultPaymentGroupName)
          Set the DefaultPaymentGroupName property.
 void setPaymentGroupMap(java.util.Map pPaymentGroupMap)
          Set the PaymentGroupMap property.
 
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
Constructor Detail

PaymentGroupContainerService

public PaymentGroupContainerService()
Creates a new PaymentGroupContainerService instance.

Method Detail

setCommerceIdentifierPaymentInfoMap

public void setCommerceIdentifierPaymentInfoMap(java.util.Map pCommerceIdentifierPaymentInfoMap)
Set the CommerceIdentifierPaymentInfoMap property.

Parameters:
pCommerceIdentifierPaymentInfoMap - a Map value

getCommerceIdentifierPaymentInfoMap

public java.util.Map getCommerceIdentifierPaymentInfoMap()
Return the CommerceIdentifierPaymentInfoMap property.

Specified by:
getCommerceIdentifierPaymentInfoMap in interface CommerceIdentifierPaymentInfoContainer
Returns:
a Map value

setPaymentGroupMap

public void setPaymentGroupMap(java.util.Map pPaymentGroupMap)
Set the PaymentGroupMap property.

Parameters:
pPaymentGroupMap - a Map value

getPaymentGroupMap

public java.util.Map getPaymentGroupMap()
Return the PaymentGroupMap property.

Specified by:
getPaymentGroupMap in interface PaymentGroupMapContainer
Returns:
a Map value

getCommerceIdentifierPaymentInfos

public java.util.List getCommerceIdentifierPaymentInfos(java.lang.String pCommerceIdentifierId)
The getCommerceIdentifierPaymentInfos method returns the List of CommerceIdentifierPaymentInfos corresponding to the supplied CommerceIdentifierId.

Specified by:
getCommerceIdentifierPaymentInfos in interface CommerceIdentifierPaymentInfoContainer
Parameters:
pCommerceIdentifierId - a String value
Returns:
a List value

getAllCommerceIdentifierPaymentInfos

public java.util.List getAllCommerceIdentifierPaymentInfos()
The getAllCommerceIdentifierPaymentInfos method returns one List of all CommerceIdentifierPaymentInfos in the entire Map.

Specified by:
getAllCommerceIdentifierPaymentInfos in interface CommerceIdentifierPaymentInfoContainer
Returns:
a List value

addCommerceIdentifierPaymentInfo

public void addCommerceIdentifierPaymentInfo(java.lang.String pCommerceIdentifierId,
                                             CommerceIdentifierPaymentInfo pCommerceIdentifierPaymentInfo)
The addCommerceIdentifierPaymentInfo method adds the supplied CommerceIdentifierId and CommerceIdentifierPaymentInfo to the Map.

Specified by:
addCommerceIdentifierPaymentInfo in interface CommerceIdentifierPaymentInfoContainer
Parameters:
pCommerceIdentifierId - a String value
pCommerceIdentifierPaymentInfo - a CommerceIdentifierPaymentInfo value

removeAllCommerceIdentifierPaymentInfos

public void removeAllCommerceIdentifierPaymentInfos()
The removeAllCommerceIdentifierPaymentInfos method clears the Map.

Specified by:
removeAllCommerceIdentifierPaymentInfos in interface CommerceIdentifierPaymentInfoContainer

removeCommerceIdentifierPaymentInfos

public void removeCommerceIdentifierPaymentInfos(java.lang.String pCommerceIdentifierId)
The removeCommerceIdentifierPaymentInfos method removes the CommerceIdentifierPaymentInfo corresponding to the supplied CommerceIdentifierId.

Specified by:
removeCommerceIdentifierPaymentInfos in interface CommerceIdentifierPaymentInfoContainer
Parameters:
pCommerceIdentifierId - a String value

getPaymentGroup

public PaymentGroup getPaymentGroup(java.lang.String pPaymentGroupName)
The getPaymentGroup method returns the PaymentGroup corresponding to the supplied payment name.

Specified by:
getPaymentGroup in interface PaymentGroupMapContainer
Parameters:
pPaymentGroupName - a String value
Returns:
a PaymentGroup value

addPaymentGroup

public void addPaymentGroup(java.lang.String pPaymentGroupName,
                            PaymentGroup pPaymentGroup)
The addPaymentGroup method adds the supplied payment name and PaymentGroup to the Map.

Specified by:
addPaymentGroup in interface PaymentGroupMapContainer
Parameters:
pPaymentGroupName - a String value
pPaymentGroup - a PaymentGroup value

removeAllPaymentGroups

public void removeAllPaymentGroups()
The removeAllPaymentGroups method clears the Map.

Specified by:
removeAllPaymentGroups in interface PaymentGroupMapContainer

removePaymentGroup

public void removePaymentGroup(java.lang.String pPaymentGroupName)
The removePaymentGroup method removes the PaymentGroup corresponding to the supplied payment name.

Specified by:
removePaymentGroup in interface PaymentGroupMapContainer
Parameters:
pPaymentGroupName - a String value

setDefaultPaymentGroupName

public void setDefaultPaymentGroupName(java.lang.String pDefaultPaymentGroupName)
Set the DefaultPaymentGroupName property. Part of PaymentGroupMapContainer implementation.

Specified by:
setDefaultPaymentGroupName in interface PaymentGroupMapContainer
Parameters:
pDefaultPaymentGroupName - a String value

getDefaultPaymentGroupName

public java.lang.String getDefaultPaymentGroupName()
Return the DefaultPaymentGroupName property. Part of PaymentGroupMapContainer implementation.

Specified by:
getDefaultPaymentGroupName in interface PaymentGroupMapContainer
Returns:
a String value