public class

ContactCartElement

extends Object
implements CartElement
java.lang.Object
   ↳ com.microstrategy.web.app.gui.ContactCartElement

Summary

Constants
int TYPE_ADDRESS
int TYPE_CONTACT
int TYPE_CONTACT_COLLECTION
int TYPE_DYNAMIC_RECIPIENT_LIST
int TYPE_LDAP_USER
int TYPE_LOCATION
int TYPE_MSTR_USER
int TYPE_MSTR_USER_GROUP
Public Methods
boolean equals(Object obj)
String getDisplayName()
Get display name to be used in HTML field.
String getKey()
int getType()
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(String displayName, int type, String key)
static ContactCartElement newElement(WebSubscriptionLocation location)
static ContactCartElement newElement(WebSubscriptionContact contact)
static ContactCartElement newElement(WebSubscriptionContact contact, boolean showLinkedUserName)
get a new contact cart element with a contact.
static ContactCartElement newElement(WebSubscriptionAddress address)
void setSelected(boolean flag)
Specifies whether this element has been selected.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.app.gui.CartElement

Constants

public static final int TYPE_ADDRESS

Constant Value: 1 (0x00000001)

public static final int TYPE_CONTACT

Constant Value: 3 (0x00000003)

public static final int TYPE_CONTACT_COLLECTION

Constant Value: 4 (0x00000004)

public static final int TYPE_DYNAMIC_RECIPIENT_LIST

Constant Value: 8 (0x00000008)

public static final int TYPE_LDAP_USER

Constant Value: 7 (0x00000007)

public static final int TYPE_LOCATION

Constant Value: 2 (0x00000002)

public static final int TYPE_MSTR_USER

Constant Value: 5 (0x00000005)

public static final int TYPE_MSTR_USER_GROUP

Constant Value: 6 (0x00000006)

Public Methods

public boolean equals (Object obj)

public String getDisplayName ()

Get display name to be used in HTML field.

Returns
  • String

public String getKey ()

public int getType ()

public String getValue ()

Gets formatted text for value field.

Returns
  • String

public int hashCode ()

public boolean isSelected ()

Indicates whether given Cart element is selected or not.

Returns
  • boolean value

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

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

public static ContactCartElement newElement (WebSubscriptionLocation location)

public static ContactCartElement newElement (WebSubscriptionContact contact)

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

public static ContactCartElement newElement (WebSubscriptionAddress address)

public void setSelected (boolean flag)

Specifies whether this element has been selected.

Parameters
flag boolean value