public class

WebIServerSubscriptionDynamicRecipientListImpl

extends AbstractPersistable
implements SubscriptionParserTags WebSubscriptionComponent WebSubscriptionContact WebSubscriptionDynamicRecipientList
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebIServerSubscriptionDynamicRecipientListImpl

Summary

Constants
String DEFAULT_CONTACT_ID
String DUMMY_CONTACT_ID
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.utils.subscription.SubscriptionParserTags
Fields
protected String _description
protected WebObjectsFactory _factory
protected String _id
protected boolean _isPopulated
protected String _name
protected int _type
protected String _xml
protected boolean stale
[Expand]
Inherited Fields
From class com.microstrategy.utils.serialization.AbstractPersistable
Public Methods
void addAddress(WebSubscriptionAddress address)
add address of contact
void addCollection(WebSubscriptionContact collection)
void addMember(WebSubscriptionContact member)
add the members of contact
void delete()
Removes an existing editable object from its source.
boolean equals(Object obj)
List<WebSubscriptionAddress> getAddreses()
get the addresses of contact
SimpleList getAddressesByDeliveryMode(int delMode)
Returns a SimpleList of WebSubscriptionAddress objects associated to this particular contact for a specified delivery mode.
int getContactType()
Returns the type of contact, from EnumDSSXMLSubscriptionContactType
String getDescription()
String getID()
boolean getIsAllInfo()
whether to save all info for the contact
String getLinkedUserName()
Gets the linked user name of the contact
SimpleList getLocationsByDeliveryMode(int delMode)
Returns a SimpleList of WebSubscriptionLocation objects associated to this particular contact for a specified delivery mode.
WebObjectInfo getMappingContent()
WebSubscriptionDynamicRecipientList.MappingField getMappingDevice()
WebSubscriptionDynamicRecipientList.MappingField getMappingLinkedUser()
WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationAddress()
WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationDevice()
WebSubscriptionDynamicRecipientList.MappingField getMappingPersonalization()
WebSubscriptionDynamicRecipientList.MappingField getMappingPhysicalAddress()
WebObjectInfo getMappingProject()
WebSubscriptionDynamicRecipientList.MappingField getMappingRecipientName()
WebSubscriptionContacts getMembers()
get the members of the contact
String getName()
String getName(String localeID)
WebSessionInfo getSessionInfo()
boolean getStatus()
get the status of the contact
String getStringKey()
SimpleList getSubscriptions(int deliveryMode)
Returns a SimpleList of WebSubscription objects to which this particular contact is subscribed to, for a specified delivery mode.
SimpleList getSubscriptions()
Returns a SimpleList collection of WebSubscription objects to which this DRL (dynamic recipient list) is subscribed to
SimpleList getSubscriptions(int blockBegin, int blockCount)
SimpleList getSubscriptions(int deliveryMode, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.
SimpleList getSubscriptions(WebSubscriptionsFilter filter, int blockBegin, int blockCount)
Returns a SimpleList collection of WebSubscription objects to which this particular contact is a recipient, for a specified delivery mode, from a specified begin block, up to a specified block count.
int getType()
int hashCode()
boolean isPopulated()
WebSubscriptionDynamicRecipientList.MappingField newMappingField(String attributeId, String formId)
Creates a new MappingField object.
void populate()
used to populate the object if not already populated
void removeAddress(WebSubscriptionAddress address)
remove the address of contact
void removeMember(WebSubscriptionContact member)
remove members from the contact
void save()
save this conatct
void setDescription(String description)
void setIsAllInfo(boolean isAllInfo)
Set whether to save all info for the contact
isAllInfo flag is added when we develop the save_contact XML API for Contact and contact group manager in Cloud OM.
void setLinkedUser(String linkedUserId)
set the linked User
void setMappingContent(WebObjectInfo content)
Sets the mapping content object.
void setMappingDevice(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Device property.
void setMappingLinkedUser(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Linked User property.
void setMappingNotificationAddress(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Notification Address property.
void setMappingNotificationDevice(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Notification Device property.
void setMappingPersonalization(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Personalization property.
void setMappingPhysicalAddress(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Physical Address property.
void setMappingProject(WebObjectInfo project)
Sets the project object which the mapping content is belonging to.
void setMappingRecipientName(WebSubscriptionDynamicRecipientList.MappingField field)
Sets the mapping field for Recipient Name property.
void setName(String objectName)
Sets the name of the contact
void setStatus(boolean isEnabled)
set the status for the contact
Protected Methods
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
void setID(String objectID)
void setType(int objectType)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.EditableObject
From interface com.microstrategy.web.objects.WebSubscriptionComponent
From interface com.microstrategy.web.objects.WebSubscriptionContact
From interface com.microstrategy.web.objects.WebSubscriptionDynamicRecipientList

Constants

protected static final String DEFAULT_CONTACT_ID

Constant Value: "00000000000000000000000000000000"

protected static final String DUMMY_CONTACT_ID

Constant Value: "B4759090082A4887BF2135A8C98C51A6"

Fields

protected String _description

protected WebObjectsFactory _factory

protected String _id

protected boolean _isPopulated

protected String _name

protected int _type

protected String _xml

protected boolean stale

Public Methods

public void addAddress (WebSubscriptionAddress address)

add address of contact

Parameters
address WebSubscriptionAddress

public void addCollection (WebSubscriptionContact collection)

public void addMember (WebSubscriptionContact member)

add the members of contact

Parameters
member WebSubscriptionContact

public void delete ()

Removes an existing editable object from its source. Example : removing an existing WebSchedule from IServer.

Throws
WebObjectsException

public boolean equals (Object obj)

public List<WebSubscriptionAddress> getAddreses ()

get the addresses of contact

Returns
  • List of the addresses of contact

public SimpleList getAddressesByDeliveryMode (int delMode)

Returns a SimpleList of WebSubscriptionAddress objects associated to this particular contact for a specified delivery mode.

Parameters
delMode , from EnumDSSXMLSubscriptionDeliveryType
Throws
WebObjectsException

public int getContactType ()

Returns the type of contact, from EnumDSSXMLSubscriptionContactType

public String getDescription ()

public String getID ()

public boolean getIsAllInfo ()

whether to save all info for the contact

Returns
  • whether to get all info

public String getLinkedUserName ()

Gets the linked user name of the contact

Returns
  • String full name of the linked user

public SimpleList getLocationsByDeliveryMode (int delMode)

Returns a SimpleList of WebSubscriptionLocation objects associated to this particular contact for a specified delivery mode.

Parameters
delMode , from EnumDSSXMLSubscriptionDeliveryType
Throws
WebObjectsException

public WebObjectInfo getMappingContent ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingDevice ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingLinkedUser ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationAddress ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationDevice ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingPersonalization ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingPhysicalAddress ()

public WebObjectInfo getMappingProject ()

public WebSubscriptionDynamicRecipientList.MappingField getMappingRecipientName ()

public WebSubscriptionContacts getMembers ()

get the members of the contact

Returns

public String getName ()

public String getName (String localeID)

public WebSessionInfo getSessionInfo ()

public boolean getStatus ()

get the status of the contact

public String getStringKey ()

public SimpleList getSubscriptions (int deliveryMode)

Returns a SimpleList of WebSubscription objects to which this particular contact is subscribed to, for a specified delivery mode.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType
Throws
WebObjectsException

public SimpleList getSubscriptions ()

Returns a SimpleList collection of WebSubscription objects to which this DRL (dynamic recipient list) is subscribed to

Throws
WebObjectsException

public SimpleList getSubscriptions (int blockBegin, int blockCount)

Throws
WebObjectsException

public SimpleList getSubscriptions (int deliveryMode, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular user is subscribed to, for a specified delivery mode, from a specified begin block, up to a specified block count.

Parameters
deliveryMode , from EnumDSSXMLSubscriptionDeliveryType
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
Throws
WebObjectsException

public SimpleList getSubscriptions (WebSubscriptionsFilter filter, int blockBegin, int blockCount)

Returns a SimpleList collection of WebSubscription objects to which this particular contact is a recipient, for a specified delivery mode, from a specified begin block, up to a specified block count.

Parameters
filter WebSubscriptionsFilter used to filter the results of this call. A blank filter can be retrieved from getNewSubscriptionsFilter()
blockBegin , the starting count of subscription, it is 0-based index which means set it N will return subscriptions from the (N+1)th subscription.
blockCount , block size for the incremental fetch of subscription. If set it 0, will return all subscriptions from the starting count
Returns
Throws
WebObjectsException

public int getType ()

public int hashCode ()

public boolean isPopulated ()

public WebSubscriptionDynamicRecipientList.MappingField newMappingField (String attributeId, String formId)

Creates a new MappingField object.

Parameters
attributeId The id of the attribute which the field is mapping to
formId The id of the attribute form which the field is mapping to
Returns
  • A new MappingField object

public void populate ()

used to populate the object if not already populated

public void removeAddress (WebSubscriptionAddress address)

remove the address of contact

Parameters
address WebSubscriptionAddress
Throws
WebObjectsException

public void removeMember (WebSubscriptionContact member)

remove members from the contact

Parameters
member the removed members
Throws
WebObjectsException

public void save ()

save this conatct

Throws
WebObjectsException

public void setDescription (String description)

public void setIsAllInfo (boolean isAllInfo)

Set whether to save all info for the contact
isAllInfo flag is added when we develop the save_contact XML API for Contact and contact group manager in Cloud OM.
Below is the description and usage of this flag. It is added to keep backward compatibility.
1. When it’s false, it keeps the old behavior that we remove or edit one of its addresses for this contact. We save the changed addresses.
2. When it’s true, it indicates to save all details for this contact, including all of its addresses, contact members, etc. For this case, we need pass all addresses of this contact to backend.

public void setLinkedUser (String linkedUserId)

set the linked User

Parameters
linkedUserId the linked User GUID

public void setMappingContent (WebObjectInfo content)

Sets the mapping content object.

Parameters
content The mapping content object.

public void setMappingDevice (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Device property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingLinkedUser (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Linked User property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingNotificationAddress (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Notification Address property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingNotificationDevice (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Notification Device property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingPersonalization (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Personalization property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingPhysicalAddress (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Physical Address property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setMappingProject (WebObjectInfo project)

Sets the project object which the mapping content is belonging to.

Parameters
project The project object.

public void setMappingRecipientName (WebSubscriptionDynamicRecipientList.MappingField field)

Sets the mapping field for Recipient Name property.

Parameters
field WebSubscriptionDynamicRecipientList.MappingField containing the mapping attribute id and attribute form id

public void setName (String objectName)

Sets the name of the contact

Parameters
objectName String containing the name of the contact

public void setStatus (boolean isEnabled)

set the status for the contact

Protected Methods

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)

protected void setID (String objectID)

protected void setType (int objectType)