Package com.microstrategy.web.beans
Interface AddressListBean
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebBean
,WebComponent
public interface AddressListBean extends WebBean
TheAddressListBean
is responsible for displaying and managing the user's address list.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel()
Cancels the processing of the currently active address.void
delete()
deletes the currently active address.WebSubscriptionAddress
getActiveAddress()
Returns theWebSubscriptionAddress
object that is currently being edited.SimpleList
getAddresses()
returns an uneditable list of user addresses forEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail
SimpleList
getAvailableDevices()
returns a list of available devices forEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail
int
getDeliveryMode()
Returns the delivery mode (EnumWebSubscriptionDeliveryMode
).WebSubscriptionAddress
getNewAddress()
returns a new unpopulatedWebSubscriptionAddress
object.int
getSortField()
Returns the field on which the address list would be sortedboolean
isSortAscending()
returns whether the sort is ascendingvoid
save()
saves the currently active address.void
setActiveAddress(java.lang.String addressID)
Sets theWebSubscriptionAddress
object that is being editedvoid
setDeliveryMode(int deliveryMode)
Sets the delivery mode (EnumWebSubscriptionDeliveryMode
).void
setSortAscending(boolean asc)
sets the sort order to be ascending or descendingvoid
setSortField(int sortField)
Defines the field by which sorting would be done.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebBean
getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
setDeliveryMode
void setDeliveryMode(int deliveryMode)
Sets the delivery mode (EnumWebSubscriptionDeliveryMode
).- Parameters:
deliveryMode
- the delivery mode.- Since:
- MicroStrategy Web 7.5.1
-
getDeliveryMode
int getDeliveryMode()
Returns the delivery mode (EnumWebSubscriptionDeliveryMode
).- Returns:
- deliveryMode the delivery mode.
- Since:
- MicroStrategy Web 7.5.1
-
getActiveAddress
WebSubscriptionAddress getActiveAddress()
Returns theWebSubscriptionAddress
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
WebSubscriptionAddress
object
-
getAvailableDevices
SimpleList getAvailableDevices() throws WebBeanException
returns a list of available devices forEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail
- Returns:
- a
SimpleList
of objects which can be cast to {WebSubscriptionDevice
} - Throws:
WebBeanException
- thrown if there is any error occurred
-
setActiveAddress
void setActiveAddress(java.lang.String addressID) throws WebBeanException
Sets theWebSubscriptionAddress
object that is being edited- Parameters:
addressID
- the ID of theWebSubscriptionAddress
object that should be used as the active address- Throws:
WebBeanException
- thrown if the ID passed in does not correspond to a valid address
-
save
void save() throws WebBeanException
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
-
delete
void delete() throws WebBeanException
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
-
setSortField
void setSortField(int sortField)
Defines the field by which sorting would be done.- Parameters:
sortField
- the possible values for the sort field are defined inWebSubscriptionsSource
-
getSortField
int getSortField()
Returns the field on which the address list would be sorted- Returns:
- the sort field
-
getNewAddress
WebSubscriptionAddress getNewAddress() throws WebBeanException
returns a new unpopulatedWebSubscriptionAddress
object. The new address is also set as the activeAddress.- Returns:
- a new unpopulated
WebSubscriptionAddress
object - Throws:
WebBeanException
- thrown if there is any error occurred
-
getAddresses
SimpleList getAddresses() throws WebBeanException
returns an uneditable list of user addresses forEnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail
- Returns:
SimpleList
of the the user addresses- Throws:
WebBeanException
- thrown if there is an error while retrieving the list
-
setSortAscending
void setSortAscending(boolean asc)
sets the sort order to be ascending or descending- Parameters:
asc
- true indicates ascending and false indicates descending
-
isSortAscending
boolean isSortAscending()
returns whether the sort is ascending- Returns:
- whether the sort is ascending
-
cancel
void cancel()
Cancels the processing of the currently active address. Sets the activeAddress to null and sets the xml request status toEnumRequestStatus.WebBeanRequestSuccessful
-
-