Package com.microstrategy.web.app.gui

Class ContactCartElement

java.lang.Object

com.microstrategy.web.app.gui.ContactCartElement

All Implemented Interfaces:

CartElement

public class ContactCartElement
extends java.lang.Object
implements CartElement

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	TYPE_ADDRESS
static int	TYPE_ALL_CONSUMERS_RECIPIENTS
static int	TYPE_CONTACT
static int	TYPE_CONTACT_COLLECTION
static int	TYPE_DYNAMIC_RECIPIENT_LIST
static int	TYPE_LDAP_USER
static int	TYPE_LOCATION
static int	TYPE_MSTR_USER
static int	TYPE_MSTR_USER_GROUP

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDisplayName()	Get display name to be used in HTML field.
java.lang.String	getKey()
int	getType()
java.lang.String	getValue()	Gets formatted text for value field.
int	hashCode()
boolean	isSelected()	Indicates whether given Cart element is selected or not.
static int	mapToContactType(int cartElementType)	Translate from cart element type to contact type
static ContactCartElement	newElement(WebSubscriptionAddress address)
static ContactCartElement	newElement(WebSubscriptionContact contact)
static ContactCartElement	newElement(WebSubscriptionContact contact, boolean showLinkedUserName)	get a new contact cart element with a contact.
static ContactCartElement	newElement(WebSubscriptionLocation location)
static ContactCartElement	newElement(java.lang.String displayName, int type, java.lang.String key)
void	setSelected(boolean flag)	Specifies whether this element has been selected.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_ADDRESS

public static final int TYPE_ADDRESS

See Also:

Constant Field Values

TYPE_LOCATION

public static final int TYPE_LOCATION

See Also:

Constant Field Values

TYPE_CONTACT

public static final int TYPE_CONTACT

See Also:

Constant Field Values

TYPE_CONTACT_COLLECTION

public static final int TYPE_CONTACT_COLLECTION

See Also:

Constant Field Values

TYPE_MSTR_USER

public static final int TYPE_MSTR_USER

See Also:

Constant Field Values

TYPE_MSTR_USER_GROUP

public static final int TYPE_MSTR_USER_GROUP

See Also:

Constant Field Values

TYPE_LDAP_USER

public static final int TYPE_LDAP_USER

See Also:

Constant Field Values

TYPE_DYNAMIC_RECIPIENT_LIST

public static final int TYPE_DYNAMIC_RECIPIENT_LIST

See Also:

Constant Field Values

TYPE_ALL_CONSUMERS_RECIPIENTS

public static final int TYPE_ALL_CONSUMERS_RECIPIENTS

See Also:

Constant Field Values

Method Detail

newElement

public static ContactCartElement newElement(WebSubscriptionContact contact,
                                            boolean showLinkedUserName)

get a new contact cart element with a contact.

Parameters:

contact - WebSubscriptionContact contact

showLinkedUserName - Boolean specifying if the contact's linked user name should be displayed

Returns:

ContactCartElement

Since:

MicroStrategy Web 9.0.1

newElement

public static ContactCartElement newElement(WebSubscriptionContact contact)

newElement

public static ContactCartElement newElement(WebSubscriptionAddress address)

newElement

public static ContactCartElement newElement(WebSubscriptionLocation location)

newElement

public static ContactCartElement newElement(java.lang.String displayName,
                                            int type,
                                            java.lang.String key)

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: CartElement

Get display name to be used in HTML field.

Specified by:

getDisplayName in interface CartElement

Returns:

String

getValue

public java.lang.String getValue()

Description copied from interface: CartElement

Gets formatted text for value field.

Specified by:

getValue in interface CartElement

Returns:

String

isSelected

public boolean isSelected()

Description copied from interface: CartElement

Indicates whether given Cart element is selected or not.

Specified by:

isSelected in interface CartElement

Returns:

boolean value

setSelected

public void setSelected(boolean flag)

Description copied from interface: CartElement

Specifies whether this element has been selected.

Specified by:

setSelected in interface CartElement

Parameters:

flag - boolean value

getKey

public java.lang.String getKey()

getType

public int getType()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

mapToContactType

public static int mapToContactType(int cartElementType)

Translate from cart element type to contact type

Parameters:

cartElementType - int cart element type to be translated to a contact type

Returns:

int from EnumDSSXMLSubscriptionContactType