|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.softslate.commerce.businessobjects.core.BaseBusinessObject com.softslate.commerce.businessobjects.core.UserBean
public class UserBean
Represents an end user accessing the system. UserBean
is the
default implementation of the User
interface for the
application.
User
,
Serialized FormField Summary | |
---|---|
private Administrator |
administrator
|
private Customer |
customer
|
private java.util.Map |
customMap
|
private java.util.Map |
dynamicShippingOptions
|
private java.util.Collection |
enteredCouponCodes
|
private java.util.Locale |
locale
|
(package private) static org.apache.commons.logging.Log |
log
|
private Order |
order
|
private static long |
serialVersionUID
|
Constructor Summary | |
---|---|
UserBean()
|
Method Summary | |
---|---|
Administrator |
getAdministrator()
Retrieves the Administrator object associated with this
User . |
Customer |
getCustomer()
Retrieves the Customer object associated with this
User . |
java.util.Map |
getCustomMap()
Returns a Map of any custom objects saved for this
User . |
java.util.Map |
getDynamicShippingOptions()
Returns the Map of dynamically generated shipping options
saved for this User . |
java.util.Collection |
getEnteredCouponCodes()
Retrieves a Collection of String s
representing coupon codes entered by this User . |
java.util.Locale |
getLocale()
Retrieves the Locale in effect for this User . |
Order |
getOrder()
Retrieves the Order this User is currently
placing. |
void |
setAdministrator(Administrator administrator)
Sets the Administrator object associated with this
User . |
void |
setCustomer(Customer customer)
Sets the Customer object associated with this
User . |
void |
setCustomMap(java.util.Map customMap)
Sets the Map of custom objects for this User . |
void |
setDynamicShippingOptions(java.util.Map dynamicShippingOptions)
Sets the Map of dynamically generated shipping options
presented to this User . |
void |
setEnteredCouponCodes(java.util.Collection enteredCouponCodes)
Sets the Collection of coupon codes entered by this
User . |
void |
setLocale(java.util.Locale locale)
Sets the Locale in effect for this User . |
void |
setOrder(Order order)
Sets the Order this User is currently
placing. |
Methods inherited from class com.softslate.commerce.businessobjects.core.BaseBusinessObject |
---|
initialize |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject |
---|
initialize |
Field Detail |
---|
private static final long serialVersionUID
static org.apache.commons.logging.Log log
private java.util.Locale locale
getLocale()
private Order order
getOrder()
private Customer customer
getCustomer()
private java.util.Collection enteredCouponCodes
getEnteredCouponCodes()
private Administrator administrator
getAdministrator()
private java.util.Map customMap
getCustomMap()
private java.util.Map dynamicShippingOptions
getDynamicShippingOptions()
Constructor Detail |
---|
public UserBean()
Method Detail |
---|
public java.util.Locale getLocale()
User
Locale
in effect for this User
.
Useful to assist with the formatting of currencies and other
localizations.
getLocale
in interface User
Locale
in effect for this User
.public void setLocale(java.util.Locale locale)
User
Locale
in effect for this User
.
This Locale
is set in the Struts layer directly after a
User
object is created in each user's session.
setLocale
in interface User
public Order getOrder()
User
Order
this User
is currently
placing. This Order
object is created when the user adds
the first item to his or her cart. It is destroyed either when the user
completes the order, or when his or her session ends.
getOrder
in interface User
Order
this User
is currently
placing.public void setOrder(Order order)
User
Order
this User
is currently
placing. This Order
object is created when the user adds
the first item to his or her cart. It is destroyed either when the user
completes the order, or when his or her session ends.
setOrder
in interface User
order
- The Order
this User
is currently
placing.public Customer getCustomer()
User
Customer
object associated with this
User
. When a user logs in as a customer, this
Customer
object is created to store his or her account
settings and other information.
getCustomer
in interface User
Customer
object associated with this
User
, or null
, if the user has
not logged in.public void setCustomer(Customer customer)
User
Customer
object associated with this
User
. When a user logs in as a customer, this
Customer
object is created to store his or her account
settings and other information.
setCustomer
in interface User
customer
- The Customer
object associated with this
User
.public java.util.Collection getEnteredCouponCodes()
User
Collection
of String
s
representing coupon codes entered by this User
. When a
user enters a coupon code at any point in the session, the code gets
stored here for retrieval during discount processing.
getEnteredCouponCodes
in interface User
Collection
of String
s
representing coupon codes entered by this User
.public void setEnteredCouponCodes(java.util.Collection enteredCouponCodes)
User
Collection
of coupon codes entered by this
User
. When a user enters a valid coupon code, the code
gets stored here for later retrieval during discount processing.
setEnteredCouponCodes
in interface User
enteredCouponCodes
- A Collection
of String
s
representing coupon codes entered by this User
.public Administrator getAdministrator()
User
Administrator
object associated with this
User
. When a user logs in as an administrator, this
Administrator
object is created to store his or her
account settings and other information.
getAdministrator
in interface User
Administrator
object associated with this
User
, or null
, if the user has
not logged in.public void setAdministrator(Administrator administrator)
User
Administrator
object associated with this
User
. When a user logs in as an administrator, this
Administrator
object is created to store his or her
account settings and other information.
setAdministrator
in interface User
administrator
- The Administrator
object associated with this
User
.public java.util.Map getCustomMap()
User
Map
of any custom objects saved for this
User
. Custom developers may place objects in the map
which need to be stored with the user throughout his session.
getCustomMap
in interface User
Map
of custom objects saved for this
User
.public void setCustomMap(java.util.Map customMap)
User
Map
of custom objects for this User
.
Custom developers may place objects in the map which need to be stored
with the user throughout his session.
setCustomMap
in interface User
customMap
- A Map
of custom objects saved for this
User
public java.util.Map getDynamicShippingOptions()
User
Map
of dynamically generated shipping options
saved for this User
. They are stored here in order to
preserve them between http requests.
getDynamicShippingOptions
in interface User
Map
of DynamicShippingOption
s.
The keys are the optionId String
s. One of these
should match the value returned by
BaseShippingProcessor.getSelectedOption()
.DynamicShippingOption
public void setDynamicShippingOptions(java.util.Map dynamicShippingOptions)
User
Map
of dynamically generated shipping options
presented to this User
.
setDynamicShippingOptions
in interface User
dynamicShippingOptions
- A Map
of DynamicShippingOption
s
representing shipping choices available to this
User
. The keys are the optionId
String
s. One of these should match the value
returned by
BaseShippingProcessor.getSelectedOption()
.DynamicShippingOption
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |