public interface

WebContactsSource

com.microstrategy.web.objects.WebContactsSource

Class Overview

The WebContactsSource is used for browsing of contact objects in the MD. You can set the blockBegin and blockCount parameters that will enable incremental fetch of the contact objects. You can also set a filter as a 'search' criteria.

Summary

Constants
int ENABLED_CONTACTS_FLAG_INCLUDE_ALL
int ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY
int ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY
Public Methods
abstract void deleteContact(String contactID)
Delete contact with specified ID from metadata
abstract void deleteContacts(List<String> contactIDList)
Delete contacts
abstract void disableContact(String contactID)
Disable contact with specified ID from metadata
abstract void enableContact(String contactID)
enable contact with specified ID from metadata
abstract int getBlockBegin()
Returns the block begin that has been set on WebContactsSource.
abstract int getBlockCount()
Returns the block count that has been set on WebContactsSource.
abstract WebSubscriptionContact getContact(String id)
Returns a WebSubscriptionContact given the ID of the contact
abstract WebSubscriptionContact getContact(String id, int contactType)
Returns a WebSubscriptionContact with the given ID and type
abstract WebSubscriptionContacts getContacts(boolean forceUpdate)
Returns a WebSubscriptionContacts collection based on the different parameters set on the WebContactsSource.
abstract WebSubscriptionContacts getContacts(String dssID, int dssType)
Returns a WebSubscriptionContacts collection on the report or document based on the different parameters set on the WebContactsSource.
abstract WebSubscriptionContacts getContacts()
Returns a WebSubscriptionContacts collection based on the different parameters set on the WebContactsSource.
abstract WebSubscriptionContacts getContactsBySearch(List<WebContactSearchFilter> filterList, List<WebContactSearchOrderInfo> orderByList, int searchFlag)
retrieve the contacts in certain pattern
abstract int getDeliveryMode()
Returns the delivery mode of contacts that is used in retrieving the list of contacts using the getContacts() method.
abstract WebContactSearchFilter getNewContactSearchFilter()
Returns a reference to an new contact search filter.
abstract WebContactSearchOrderInfo getNewContactSearchOrderInfo()
Returns a reference to an new contact search order infomation
abstract WebSubscriptionContact getNewObject(int type)
Returns a reference to an new contact of the specified type.
abstract String getSearchPattern()
Returns the search pattern or filter that has been set on the WebContactsSource.
abstract void setBlockBegin(int start)
Sets the block begin that will be used while retrieving a list of contacts using the getContacts() method.
abstract void setBlockCount(int count)
Sets the block count that will be used while retrieving a list of contacts using the getContacts() method.
abstract void setContactTypesFilter(int contactType)
Set a filter of contact types, which is ORable, that will be used in the getContacts() call.
abstract void setDeliveryMode(int mode)
Sets the delivery mode of contacts that will be retrieved in the getContacts() method.
abstract void setEnabledContactsFlag(int enabledFlag)
Sets a flag that determines whether the getContacts() method returns all contacts or just the enabled contacts or just the disabled contacts.
abstract void setSearchFilter(String searchPattern)
Sets the search filter/pattern that will be used while retrieving a list of contacts using the getContacts() method.
abstract void setSecurityEnabledOnly(boolean securityEnabled)
Sets a flag that determines whether the getContacts() method returns all contacts or just the ones which have a user associated with it.

Constants

public static final int ENABLED_CONTACTS_FLAG_INCLUDE_ALL

Constant Value: -1 (0xffffffff)

public static final int ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY

Constant Value: 0 (0x00000000)

public static final int ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY

Constant Value: 1 (0x00000001)

Public Methods

public abstract void deleteContact (String contactID)

Delete contact with specified ID from metadata

Parameters
contactID String containing the contact ID for the contact to be deleted
Throws
WebObjectsException

public abstract void deleteContacts (List<String> contactIDList)

Delete contacts

Throws
WebObjectsException

public abstract void disableContact (String contactID)

Disable contact with specified ID from metadata

Parameters
contactID String containing the contact ID for the contact to be disabled
Throws
WebObjectsException

public abstract void enableContact (String contactID)

enable contact with specified ID from metadata

Parameters
contactID String containing the contact ID for the contact to be disabled
Throws
WebObjectsException

public abstract int getBlockBegin ()

Returns the block begin that has been set on WebContactsSource.

public abstract int getBlockCount ()

Returns the block count that has been set on WebContactsSource.

public abstract WebSubscriptionContact getContact (String id)

Returns a WebSubscriptionContact given the ID of the contact

public abstract WebSubscriptionContact getContact (String id, int contactType)

Returns a WebSubscriptionContact with the given ID and type

Parameters
id String containing the contact id
contactType int from EnumDSSXMLSubscriptionContactType
Returns

public abstract WebSubscriptionContacts getContacts (boolean forceUpdate)

Returns a WebSubscriptionContacts collection based on the different parameters set on the WebContactsSource. The different parameters include setBlockBegin(int), setBlockCount(int), setSearchFilter(String), setDeliveryMode(int), setEnabledContactsFlag(int) etc.

Parameters
forceUpdate Flag to force update or retrieve the contacts from IServer
Throws
WebObjectsException

public abstract WebSubscriptionContacts getContacts (String dssID, int dssType)

Returns a WebSubscriptionContacts collection on the report or document based on the different parameters set on the WebContactsSource. The different parameters include setBlockBegin(int), setBlockCount(int), setSearchFilter(String), setDeliveryMode(int), setEnabledContactsFlag(int) etc.

Parameters
dssID report or document DSS ID
dssType report or document
Throws
WebObjectsException

public abstract WebSubscriptionContacts getContacts ()

Returns a WebSubscriptionContacts collection based on the different parameters set on the WebContactsSource. The different parameters include setBlockBegin(int), setBlockCount(int), setSearchFilter(String), setDeliveryMode(int), setEnabledContactsFlag(int) etc.

Throws
WebObjectsException

public abstract WebSubscriptionContacts getContactsBySearch (List<WebContactSearchFilter> filterList, List<WebContactSearchOrderInfo> orderByList, int searchFlag)

retrieve the contacts in certain pattern

Parameters
filterList List of filters WebContactSearchFilter
orderByList List of order {@Link WebContactSearchOrderInfo}
searchFlag {@Link EnumDSSXMLNCSContactSourceField}
Returns
Throws
WebObjectsException

public abstract int getDeliveryMode ()

Returns the delivery mode of contacts that is used in retrieving the list of contacts using the getContacts() method. From EnumDSSXMLSubscriptionDeliveryType

public abstract WebContactSearchFilter getNewContactSearchFilter ()

Returns a reference to an new contact search filter.

Returns

public abstract WebContactSearchOrderInfo getNewContactSearchOrderInfo ()

Returns a reference to an new contact search order infomation

Returns

public abstract WebSubscriptionContact getNewObject (int type)

Returns a reference to an new contact of the specified type.

Parameters
type integer type of the component as defined in EnumWebSubscriptionContactType
Returns
Throws
WebObjectsException Thrown if the type specified is not supported

public abstract String getSearchPattern ()

Returns the search pattern or filter that has been set on the WebContactsSource.

public abstract void setBlockBegin (int start)

Sets the block begin that will be used while retrieving a list of contacts using the getContacts() method. This is used for supporting incremental fetch of the contacts.

public abstract void setBlockCount (int count)

Sets the block count that will be used while retrieving a list of contacts using the getContacts() method. This is used for supporting incremental fetch of the contacts.

public abstract void setContactTypesFilter (int contactType)

Set a filter of contact types, which is ORable, that will be used in the getContacts() call.

Parameters
contactType from EnumDSSXMLSubscriptionContactType

public abstract void setDeliveryMode (int mode)

Sets the delivery mode of contacts that will be retrieved in the getContacts() method. From EnumDSSXMLSubscriptionDeliveryType

public abstract void setEnabledContactsFlag (int enabledFlag)

Sets a flag that determines whether the getContacts() method returns all contacts or just the enabled contacts or just the disabled contacts. The flag can take one of the following values ENABLED_CONTACTS_FLAG_INCLUDE_ALL, ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY, ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY

public abstract void setSearchFilter (String searchPattern)

Sets the search filter/pattern that will be used while retrieving a list of contacts using the getContacts() method.

public abstract void setSecurityEnabledOnly (boolean securityEnabled)

Sets a flag that determines whether the getContacts() method returns all contacts or just the ones which have a user associated with it.