AddressListBean
implements WebBean| com.microstrategy.web.beans.AddressListBean |
Class Overview
The AddressListBean is responsible for displaying and managing
the user's address list.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
cancel()
Cancels the processing of the currently active address.
| ||||||||||
| abstract void |
delete()
deletes the currently active address.
| ||||||||||
| abstract WebSubscriptionAddress |
getActiveAddress()
Returns the
WebSubscriptionAddress object that is currently
being edited. | ||||||||||
| abstract SimpleList |
getAddresses()
returns an uneditable list of user addresses for
DssXmlDeliveryTypeEmail | ||||||||||
| abstract SimpleList |
getAvailableDevices()
returns a list of available devices for
DssXmlDeliveryTypeEmail | ||||||||||
| abstract int |
getDeliveryMode()
Returns the delivery mode (
EnumWebSubscriptionDeliveryMode). | ||||||||||
| abstract WebSubscriptionAddress |
getNewAddress()
returns a new unpopulated
WebSubscriptionAddress object. | ||||||||||
| abstract int |
getSortField()
Returns the field on which the address list would be sorted
| ||||||||||
| abstract boolean |
isSortAscending()
returns whether the sort is ascending
| ||||||||||
| abstract void |
save()
saves the currently active address.
| ||||||||||
| abstract void |
setActiveAddress(String addressID)
Sets the
WebSubscriptionAddress object that is being edited | ||||||||||
| abstract void |
setDeliveryMode(int deliveryMode)
Sets the delivery mode (
EnumWebSubscriptionDeliveryMode). | ||||||||||
| abstract void |
setSortAscending(boolean asc)
sets the sort order to be ascending or descending
| ||||||||||
| abstract void |
setSortField(int sortField)
Defines the field by which sorting would be done.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
|
From interface
com.microstrategy.web.beans.RequestPersistable
| |||||||||||
|
From interface
com.microstrategy.web.beans.Transformable
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebBean
| |||||||||||
|
From interface
com.microstrategy.web.beans.WebComponent
| |||||||||||
Public Methods
public abstract void cancel ()
Cancels the processing of the currently active address.
Sets the activeAddress to null and sets the xml request status to WebBeanRequestSuccessful
public abstract void delete ()
deletes the currently active address. If there is a no active address, then this is a no operation
Throws
| WebBeanException | thrown if there is any error occurred |
|---|
public abstract WebSubscriptionAddress getActiveAddress ()
Returns the WebSubscriptionAddress object that is currently
being edited. If there is no such object, then this method returns null. This method would primarily be
used by the transform to render the address being edited appropriately.
Returns
- the
WebSubscriptionAddressobject
public abstract SimpleList getAddresses ()
returns an uneditable list of user addresses for DssXmlDeliveryTypeEmail
Returns
SimpleListof the the user addresses
Throws
| WebBeanException | thrown if there is an error while retrieving the list |
|---|
public abstract SimpleList getAvailableDevices ()
returns a list of available devices for DssXmlDeliveryTypeEmail
Returns
- a
SimpleListof objects which can be cast to {WebSubscriptionDevice}
Throws
| WebBeanException | thrown if there is any error occurred |
|---|
public abstract int getDeliveryMode ()
Returns the delivery mode (EnumWebSubscriptionDeliveryMode).
Returns
- deliveryMode the delivery mode.
public abstract WebSubscriptionAddress getNewAddress ()
returns a new unpopulated WebSubscriptionAddress object.
The new address is also set as the activeAddress.
Returns
- a new unpopulated
WebSubscriptionAddressobject
Throws
| WebBeanException | thrown if there is any error occurred |
|---|
public abstract int getSortField ()
Returns the field on which the address list would be sorted
Returns
- the sort field
public abstract boolean isSortAscending ()
returns whether the sort is ascending
Returns
- whether the sort is ascending
public abstract void save ()
saves the currently active address. If there is a no active address, then this is a no operation
Throws
| WebBeanException | thrown if there is any error occurred |
|---|
public abstract void setActiveAddress (String addressID)
Sets the WebSubscriptionAddress object that is being edited
Parameters
| addressID | the ID of the WebSubscriptionAddress object that should be used
as the active address |
|---|
Throws
| WebBeanException | thrown if the ID passed in does not correspond to a valid address |
|---|
public abstract void setDeliveryMode (int deliveryMode)
Sets the delivery mode (EnumWebSubscriptionDeliveryMode).
Parameters
| deliveryMode | the delivery mode. |
|---|
public abstract void setSortAscending (boolean asc)
sets the sort order to be ascending or descending
Parameters
| asc | true indicates ascending and false indicates descending |
|---|
public abstract void setSortField (int sortField)
Defines the field by which sorting would be done.
Parameters
| sortField | the possible values for the sort field are defined in WebSubscriptionsSource |
|---|