WebSubscriptionUserAddresses
implements Persistable| com.microstrategy.web.objects.admin.users.WebSubscriptionUserAddresses |
Class Overview
This interface allows the client to manage multiple addresses associated with a WebUser in memory
and apply all the changes in one call. The changes will be persisted in the metadata when the save on the associated user gets invoked. Until then, the changes
are all retained in memory
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebSubscriptionAddress |
addNewAddress(int delMode)
This method creates a new
WebSubscriptionAddress with a given delivery mode.@return | ||||||||||
| abstract WebSubscriptionAddress |
get(int i)
This method returns a
WebSubscriptionAddress given an index of the address in the address list.@return | ||||||||||
| abstract WebSubscriptionAddress |
getAddress(String id)
This method returns a
WebSubscriptionAddress given the address ID.@return | ||||||||||
| abstract void |
remove(WebSubscriptionAddress address)
This method removes a
WebSubscriptionAddress from WebSubscriptionUserAddresses for a user given a WebSubscriptionAddress. | ||||||||||
| abstract void |
remove(String addressID)
This method removes an
WebSubscriptionAddress from WebSubscriptionUserAddresses for a user given an address ID. | ||||||||||
| abstract void |
save()
This methods saves modification of the
WebSubscriptionUserAddresses and persist the changes to the server. | ||||||||||
| abstract void |
saveAddress(WebSubscriptionAddress address)
This method adds a newly created or modified
WebSubscriptionAddress to a list, so that all the changes can be later saved to the server. | ||||||||||
| abstract void |
setDefaultAddress(String addressID)
This method sets the default address, making sure that only one address is set to default for the
same delivery mode.
| ||||||||||
| abstract int |
size()
This method returns the size of the WebSubscriptionAddress list.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
Public Methods
public abstract WebSubscriptionAddress addNewAddress (int delMode)
This method creates a new WebSubscriptionAddress with a given delivery mode.@return
Throws
| WebObjectsException |
|---|
public abstract WebSubscriptionAddress get (int i)
This method returns a WebSubscriptionAddress given an index of the address in the address list.@return
Throws
| WebObjectsException | |
| IllegalArgumentException | |
| WebObjectsException |
public abstract WebSubscriptionAddress getAddress (String id)
This method returns a WebSubscriptionAddress given the address ID.@return
Throws
| WebObjectsException | |
| IllegalArgumentException | |
| WebObjectsException |
public abstract void remove (WebSubscriptionAddress address)
This method removes a WebSubscriptionAddress from WebSubscriptionUserAddresses for a user given a WebSubscriptionAddress.
Throws
| WebObjectsException | |
| IllegalArgumentException | |
| WebObjectsException |
public abstract void remove (String addressID)
This method removes an WebSubscriptionAddress from WebSubscriptionUserAddresses for a user given an address ID.
Throws
| WebObjectsException | |
| IllegalArgumentException | |
| WebObjectsException |
public abstract void save ()
This methods saves modification of the WebSubscriptionUserAddresses and persist the changes to the server.
Throws
| WebObjectsException |
|---|
public abstract void saveAddress (WebSubscriptionAddress address)
This method adds a newly created or modified WebSubscriptionAddress to a list, so that all the changes can be later saved to the server.
public abstract void setDefaultAddress (String addressID)
This method sets the default address, making sure that only one address is set to default for the same delivery mode.
Throws
| WebObjectsException |
|---|
public abstract int size ()
This method returns the size of the WebSubscriptionAddress list.
Returns
- size of the WebSubscriptionAddress list