public interface

WebSubscriptionContact

implements WebSubscriptionComponent
com.microstrategy.web.objects.WebSubscriptionContact
Known Indirect Subclasses

Class Overview

This interface represents a 'Contact' object. It is used in the context of Distribution Services. A contact is an object that contains a list of addresses and is linked to a WebUserEntity. When the subscription is executed, the report/document is run using the credentials of this user. By default every user has a 'default' contact which contains all the addresses and locations of the user (available from the User Preferences page in Web). The default contact is not pre-created, but is created on the fly as and when required.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void addAddress(WebSubscriptionAddress address)
add address of contact
abstract void addMember(WebSubscriptionContact member)
add the members of contact
abstract List<WebSubscriptionAddress> getAddreses()
get the addresses of contact
abstract SimpleList getAddressesByDeliveryMode(int delMode)
Returns a SimpleList of WebSubscriptionAddress objects associated to this particular contact for a specified delivery mode.
abstract int getContactType()
Returns the type of contact, from EnumDSSXMLSubscriptionContactType
abstract boolean getIsAllInfo()
whether to save all info for the contact
abstract String getLinkedUserName()
Gets the linked user name of the contact
abstract SimpleList getLocationsByDeliveryMode(int delMode)
Returns a SimpleList of WebSubscriptionLocation objects associated to this particular contact for a specified delivery mode.
abstract WebSubscriptionContacts getMembers()
get the members of the contact
abstract boolean getStatus()
get the status of the contact
abstract SimpleList getSubscriptions(int deliveryMode)
Returns a SimpleList of WebSubscription objects to which this particular contact is subscribed to, for a specified delivery mode.
abstract 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.
abstract 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.
abstract void removeAddress(WebSubscriptionAddress address)
remove the address of contact
abstract void removeMember(WebSubscriptionContact member)
remove members from the contact
abstract void save()
save this conatct
abstract void setDescription(String description)
set description of contact
abstract 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.
abstract void setLinkedUser(String linkedUser)
set the linked User
abstract void setName(String displayName)
Sets the name of the contact
abstract void setStatus(boolean isEnabled)
set the status for the contact
[Expand]
Inherited Methods
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionComponent

Public Methods

public abstract void addAddress (WebSubscriptionAddress address)

add address of contact

Parameters
address WebSubscriptionAddress

public abstract void addMember (WebSubscriptionContact member)

add the members of contact

Parameters
member WebSubscriptionContact

public abstract List<WebSubscriptionAddress> getAddreses ()

get the addresses of contact

Returns
  • List of the addresses of contact

public abstract 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 abstract int getContactType ()

Returns the type of contact, from EnumDSSXMLSubscriptionContactType

public abstract boolean getIsAllInfo ()

whether to save all info for the contact

Returns
  • whether to get all info

public abstract String getLinkedUserName ()

Gets the linked user name of the contact

Returns
  • String full name of the linked user

public abstract 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 abstract WebSubscriptionContacts getMembers ()

get the members of the contact

Returns

public abstract boolean getStatus ()

get the status of the contact

public abstract 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 abstract 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 abstract 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 abstract void removeAddress (WebSubscriptionAddress address)

remove the address of contact

Parameters
address WebSubscriptionAddress
Throws
WebObjectsException

public abstract void removeMember (WebSubscriptionContact member)

remove members from the contact

Parameters
member the removed members
Throws
WebObjectsException

public abstract void save ()

save this conatct

Throws
WebObjectsException

public abstract void setDescription (String description)

set description of contact

public abstract 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 abstract void setLinkedUser (String linkedUser)

set the linked User

Parameters
linkedUser the linked User GUID

public abstract void setName (String displayName)

Sets the name of the contact

Parameters
displayName String containing the name of the contact

public abstract void setStatus (boolean isEnabled)

set the status for the contact