Package com.microstrategy.web.objects
Interface WebContactsSource
-
public interface WebContactsSource
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.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
ENABLED_CONTACTS_FLAG_INCLUDE_ALL
static int
ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY
static int
ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteContact(java.lang.String contactID)
Delete contact with specified ID from metadatavoid
deleteContacts(java.util.List<java.lang.String> contactIDList)
Delete contactsvoid
disableContact(java.lang.String contactID)
Disable contact with specified ID from metadatavoid
enableContact(java.lang.String contactID)
enable contact with specified ID from metadataint
getBlockBegin()
Returns the block begin that has been set onWebContactsSource
.int
getBlockCount()
Returns the block count that has been set onWebContactsSource
.WebSubscriptionContact
getContact(java.lang.String id)
Returns aWebSubscriptionContact
given the ID of the contactWebSubscriptionContact
getContact(java.lang.String id, int contactType)
Returns aWebSubscriptionContact
with the given ID and typeWebSubscriptionContacts
getContacts()
Returns aWebSubscriptionContacts
collection based on the different parameters set on theWebContactsSource
.WebSubscriptionContacts
getContacts(boolean forceUpdate)
Returns aWebSubscriptionContacts
collection based on the different parameters set on theWebContactsSource
.WebSubscriptionContacts
getContacts(java.lang.String dssID, int dssType)
Returns aWebSubscriptionContacts
collection on the report or document based on the different parameters set on theWebContactsSource
.WebSubscriptionContacts
getContacts(java.util.List<ObjectIdTypeAndProjectId> dssIDsAndTypes)
Returns aWebSubscriptionContacts
collection on a list of report or document based on the different parameters set on theWebContactsSource
.WebSubscriptionContacts
getContactsBySearch(java.util.List<WebContactSearchFilter> filterList, java.util.List<WebContactSearchOrderInfo> orderByList, int searchFlag)
retrieve the contacts in certain patternint
getDeliveryMode()
Returns the delivery mode of contacts that is used in retrieving the list of contacts using thegetContacts()
method.WebContactSearchFilter
getNewContactSearchFilter()
Returns a reference to an new contact search filter.WebContactSearchOrderInfo
getNewContactSearchOrderInfo()
Returns a reference to an new contact search order infomationWebSubscriptionContact
getNewObject(int type)
Returns a reference to an new contact of the specified type.java.lang.String
getSearchPattern()
Returns the search pattern or filter that has been set on theWebContactsSource
.void
setBlockBegin(int start)
Sets the block begin that will be used while retrieving a list of contacts using thegetContacts()
method.void
setBlockCount(int count)
Sets the block count that will be used while retrieving a list of contacts using thegetContacts()
method.void
setContactTypesFilter(int contactType)
Set a filter of contact types, which is ORable, that will be used in thegetContacts()
call.void
setDeliveryMode(int mode)
Sets the delivery mode of contacts that will be retrieved in thegetContacts()
method.void
setEnabledContactsFlag(int enabledFlag)
Sets a flag that determines whether thegetContacts()
method returns all contacts or just the enabled contacts or just the disabled contacts.void
setSearchFilter(java.lang.String searchPattern)
Sets the search filter/pattern that will be used while retrieving a list of contacts using thegetContacts()
method.void
setSecurityEnabledOnly(boolean securityEnabled)
Sets a flag that determines whether thegetContacts()
method returns all contacts or just the ones which have a user associated with it.
-
-
-
Field Detail
-
ENABLED_CONTACTS_FLAG_INCLUDE_ALL
static final int ENABLED_CONTACTS_FLAG_INCLUDE_ALL
- See Also:
- Constant Field Values
-
ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY
static final int ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY
- See Also:
- Constant Field Values
-
ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY
static final int ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY
- See Also:
- Constant Field Values
-
-
Method Detail
-
setBlockBegin
void setBlockBegin(int start)
Sets the block begin that will be used while retrieving a list of contacts using thegetContacts()
method. This is used for supporting incremental fetch of the contacts.- Parameters:
start
-
-
getBlockBegin
int getBlockBegin()
Returns the block begin that has been set onWebContactsSource
.
-
setBlockCount
void setBlockCount(int count)
Sets the block count that will be used while retrieving a list of contacts using thegetContacts()
method. This is used for supporting incremental fetch of the contacts.- Parameters:
count
-
-
getBlockCount
int getBlockCount()
Returns the block count that has been set onWebContactsSource
.
-
setSearchFilter
void setSearchFilter(java.lang.String searchPattern)
Sets the search filter/pattern that will be used while retrieving a list of contacts using thegetContacts()
method.- Parameters:
searchPattern
-
-
getSearchPattern
java.lang.String getSearchPattern()
Returns the search pattern or filter that has been set on theWebContactsSource
.
-
getContacts
WebSubscriptionContacts getContacts() throws WebObjectsException
Returns aWebSubscriptionContacts
collection based on the different parameters set on theWebContactsSource
. The different parameters includesetBlockBegin(int)
,setBlockCount(int)
,setSearchFilter(String)
,setDeliveryMode(int)
,setEnabledContactsFlag(int)
etc.- Throws:
WebObjectsException
-
getContacts
WebSubscriptionContacts getContacts(java.lang.String dssID, int dssType) throws WebObjectsException
Returns aWebSubscriptionContacts
collection on the report or document based on the different parameters set on theWebContactsSource
. The different parameters includesetBlockBegin(int)
,setBlockCount(int)
,setSearchFilter(String)
,setDeliveryMode(int)
,setEnabledContactsFlag(int)
etc.- Parameters:
dssID
- report or document DSS IDdssType
- report or document- Throws:
WebObjectsException
-
getContacts
WebSubscriptionContacts getContacts(java.util.List<ObjectIdTypeAndProjectId> dssIDsAndTypes) throws WebObjectsException
Returns aWebSubscriptionContacts
collection on a list of report or document based on the different parameters set on theWebContactsSource
. The different parameters includesetBlockBegin(int)
,setBlockCount(int)
,setSearchFilter(String)
,setDeliveryMode(int)
,setEnabledContactsFlag(int)
etc.- Parameters:
dssIDsAndTypes
- report or document DSS ID and the corresponding type of each report or document and the project it belongs to- Throws:
WebObjectsException
-
getContacts
WebSubscriptionContacts getContacts(boolean forceUpdate) throws WebObjectsException
Returns aWebSubscriptionContacts
collection based on the different parameters set on theWebContactsSource
. The different parameters includesetBlockBegin(int)
,setBlockCount(int)
,setSearchFilter(String)
,setDeliveryMode(int)
,setEnabledContactsFlag(int)
etc.- Parameters:
forceUpdate
- Flag to force update or retrieve the contacts from IServer- Throws:
WebObjectsException
-
setDeliveryMode
void setDeliveryMode(int mode)
Sets the delivery mode of contacts that will be retrieved in thegetContacts()
method. FromEnumDSSXMLSubscriptionDeliveryType
- Parameters:
mode
-
-
getDeliveryMode
int getDeliveryMode()
Returns the delivery mode of contacts that is used in retrieving the list of contacts using thegetContacts()
method. FromEnumDSSXMLSubscriptionDeliveryType
-
getContact
WebSubscriptionContact getContact(java.lang.String id, int contactType)
Returns aWebSubscriptionContact
with the given ID and type- Parameters:
id
-String
containing the contact idcontactType
- int fromEnumDSSXMLSubscriptionContactType
- Returns:
WebSubscriptionContact
-
getContact
WebSubscriptionContact getContact(java.lang.String id)
Returns aWebSubscriptionContact
given the ID of the contact- Parameters:
id
-
-
setContactTypesFilter
void setContactTypesFilter(int contactType)
Set a filter of contact types, which is ORable, that will be used in thegetContacts()
call.- Parameters:
contactType
- fromEnumDSSXMLSubscriptionContactType
-
setEnabledContactsFlag
void setEnabledContactsFlag(int enabledFlag)
Sets a flag that determines whether thegetContacts()
method returns all contacts or just the enabled contacts or just the disabled contacts. The flag can take one of the following valuesENABLED_CONTACTS_FLAG_INCLUDE_ALL
,ENABLED_CONTACTS_FLAG_INCLUDE_DISABLED_ONLY
,ENABLED_CONTACTS_FLAG_INCLUDE_ENABLED_ONLY
- Parameters:
enabledFlag
-
-
setSecurityEnabledOnly
void setSecurityEnabledOnly(boolean securityEnabled)
Sets a flag that determines whether thegetContacts()
method returns all contacts or just the ones which have a user associated with it.- Parameters:
securityEnabled
-
-
deleteContact
void deleteContact(java.lang.String contactID) throws WebObjectsException
Delete contact with specified ID from metadata- Parameters:
contactID
-String
containing the contact ID for the contact to be deleted- Throws:
WebObjectsException
- Since:
- MicroStrategy Web 9.0.1
-
disableContact
void disableContact(java.lang.String contactID) throws WebObjectsException
Disable contact with specified ID from metadata- Parameters:
contactID
-String
containing the contact ID for the contact to be disabled- Throws:
WebObjectsException
-
enableContact
void enableContact(java.lang.String contactID) throws WebObjectsException
enable contact with specified ID from metadata- Parameters:
contactID
-String
containing the contact ID for the contact to be disabled- Throws:
WebObjectsException
-
getNewObject
WebSubscriptionContact getNewObject(int type) throws WebObjectsException
Returns a reference to an new contact of the specified type.- Parameters:
type
- integer type of the component as defined inEnumDSSXMLSubscriptionContactType
- Returns:
WebSubscriptionContact
- Throws:
WebObjectsException
- Thrown if the type specified is not supported
-
getContactsBySearch
WebSubscriptionContacts getContactsBySearch(java.util.List<WebContactSearchFilter> filterList, java.util.List<WebContactSearchOrderInfo> orderByList, int searchFlag) throws WebObjectsException
retrieve the contacts in certain pattern- Parameters:
filterList
- List of filtersWebContactSearchFilter
orderByList
- List of ordersearchFlag
-- Returns:
WebSubscriptionContacts
- Throws:
WebObjectsException
-
deleteContacts
void deleteContacts(java.util.List<java.lang.String> contactIDList) throws WebObjectsException
Delete contacts- Parameters:
contactIDList
- List of deleted contacts' GUID- Throws:
WebObjectsException
-
getNewContactSearchFilter
WebContactSearchFilter getNewContactSearchFilter()
Returns a reference to an new contact search filter.- Returns:
WebContactSearchFilter
-
getNewContactSearchOrderInfo
WebContactSearchOrderInfo getNewContactSearchOrderInfo()
Returns a reference to an new contact search order infomation- Returns:
WebContactSearchOrderInfo
-
-