Package com.microstrategy.web.objects

Class WebIServerSubscriptionDynamicRecipientListImpl

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.objects.WebIServerSubscriptionDynamicRecipientListImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, StringKey, SubscriptionParserTags, EditableObject, WebSubscriptionComponent, WebSubscriptionContact, WebSubscriptionDynamicRecipientList

public class WebIServerSubscriptionDynamicRecipientListImpl
extends AbstractPersistable
implements WebSubscriptionDynamicRecipientList

Nested Class Summary

Nested classes/interfaces inherited from interface com.microstrategy.web.objects.WebSubscriptionDynamicRecipientList

WebSubscriptionDynamicRecipientList.MappingField

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_description
protected WebObjectsFactory	_factory
protected java.lang.String	_id
protected boolean	_isPopulated
protected java.lang.String	_name
protected int	_type
protected java.lang.String	_xml
protected static java.lang.String	DEFAULT_CONTACT_ID
protected static java.lang.String	DUMMY_CONTACT_ID
protected boolean	stale

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Fields inherited from interface com.microstrategy.utils.subscription.SubscriptionParserTags

Att_Action, Att_AddressId, Att_AddressName, Att_AddressValue, Att_BurstLayoutKey, Att_ChangeableMask, Att_ContactFieldFlag, Att_ContactId, Att_ContactLogin, Att_ContactType, Att_ContentID, Att_CreationTime, Att_DeliveryType, Att_DetailFlag, Att_DetailFlag2, Att_DeviceId, Att_DisableContact, Att_DSSID, Att_EmailBurstAttFormID, Att_EmailBurstAttID, Att_EmailBurstDeviceID, Att_EnableContact, Att_Enabled, Att_Filter, Att_Filter_Field, Att_Fixed, Att_HasPath, Att_InstanceId, Att_Invalid_Schedule_flag, Att_IsBulkExport, Att_IsBursting, Att_IsDefaultContact, Att_IsGetAllInfo, Att_IsPersonalization, Att_IsTransient, Att_LowerBound, Att_MobileAppId, Att_MobileClientType, Att_ModificationTime, Att_Non_Schedulable, Att_NotificationID, Att_Order_By, Att_PersonalViewMode, Att_ProjectId, Att_RefreshType, Att_SecurityEnabled, Att_SendNow, Att_SubscriptionId, Att_TotalCount, Att_TriggerId, Att_UpperBound, Att_UseInstance, Att_UserId, ATTR_ADDRESS_DEFAULT, ATTR_ADDRESS_DELIVERY_WIN, ATTR_ADDRESS_DESCRIPTION, ATTR_ADDRESS_DEVICE_ID, ATTR_ADDRESS_DEVICE_NAME, ATTR_ADDRESS_ID, ATTR_ADDRESS_IS_NEW, ATTR_ADDRESS_NAME, ATTR_ADDRESS_PHYSICAL_ADD, ATTR_ADDRESS_TRANSPROPS, ATTR_COMPONENT_DESCRIPTION, ATTR_COMPONENT_ID, ATTR_COMPONENT_NAME, ATTR_SUBSCRIPITON_ERROR_DESC, ATTR_SUBSCRIPITON_ERROR_ID, START_IN_TAG, START_MI_TAG, START_OI_TAG, SUBSCRIPTION_ERROR_NODE, Tag_AddRecipients, Tag_Address, Tag_Addresses, Tag_AddressInfo, Tag_Alert, Tag_AssociateContacts, Tag_AssProjSchedules, Tag_AssSchsWithReportOrDoc, Tag_BadgeMetricID, Tag_BurstAtt, Tag_BurstAtts, Tag_BurstSubFolder, Tag_BurstXml, Tag_CacheUpdateFlag, Tag_Check_Subscription_Access, Tag_Check_Subscription_ACL, Tag_CheckNCSCS, Tag_ClientAlertingMessage, Tag_Collate, Tag_Collections, Tag_Contact, Tag_Contact_Member, Tag_ContactInfo, Tag_Contacts, Tag_ContactSecurity, Tag_Content, Tag_ContentInstance, Tag_Copies, Tag_DeliveryType, Tag_DeltaXML, Tag_Destination, Tag_Device, Tag_DeviceType, Tag_DoNotCreateUpdateCaches, Tag_EmailBurstAddress, Tag_EMMACubeOptions, Tag_ExecutionFlags, Tag_Expiration, Tag_ExportSettings, Tag_FileFormat, Tag_FileName, Tag_FilterXML, Tag_FirstPage, Tag_Get_Contacts_By_Search, Tag_GetAddress, Tag_GetAllDevices, Tag_GetContact, Tag_GetContacts, Tag_GetSchListofProj, Tag_GetSchsOfReportOrDoc, Tag_GetSubscription, Tag_GetSubscriptions, Tag_HistoryLinkUrl, Tag_HistoryLinkWebServer, Tag_IncludeData, Tag_IncludeLink, Tag_JsonSelectedFlag, Tag_LastPage, Tag_Message, Tag_MobileAppDeviceID, Tag_Notification, Tag_Personalization, Tag_PromptAnswer, Tag_ProtectZipFile, Tag_Recipients_All_Consumers, Tag_RemoveAddress, Tag_RemoveContact, Tag_RemoveContacts, Tag_RemoveDevice, Tag_RemoveSubscription, Tag_ReRunHistoryList, Tag_ReUseDataSetCache, Tag_ReuseHL, Tag_ReuseHLMsgId, Tag_SaveAddress, Tag_SaveContact, Tag_SaveSubscription, Tag_Segment, Tag_SendBadge, Tag_SendPreviewNow, Tag_SendPushNotification, Tag_SendToHistory, Tag_ShortcutCacheFormat, Tag_SpaceDelimiter, Tag_Subject, Tag_Subscription, Tag_SubscriptionInstance, Tag_Table, Tag_Tables, Tag_TransformationSettings, Tag_TriggerEvent, Tag_Triggers, Tag_Use_Print_Range, Tag_Zip, Tag_ZipFileName, Tag_ZipPassword

Method Summary

Modifier and Type	Method	Description
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(java.lang.Object obj)
java.util.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
java.lang.String	getDescription()
java.lang.String	getID()
boolean	getIsAllInfo()	whether to save all info for the contact
java.lang.String	getLinkedUserId()	Gets the linked user Id of the contact
java.lang.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
WebSubscriptionContacts	getMemberships()	get the Contact Groups of which the given contact is a member of
java.lang.String	getName()
java.lang.String	getName(java.lang.String localeID)
WebSessionInfo	getSessionInfo()
boolean	getStatus()	get the status of the contact
java.lang.String	getStringKey()
SimpleList	getSubscriptions()	Returns a SimpleList collection of WebSubscription objects to which this DRL (dynamic recipient list) is subscribed to
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(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(java.lang.String attributeId, java.lang.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	save(java.lang.String iPGUID, java.lang.String iSessionId)	Saves the new or modified object on its source.
protected void	saveXMLState(WebXMLBuilder builder, int howMuchState)
protected void	saveXMLState(java.lang.StringBuffer buf, int howMuchState)
void	setDescription(java.lang.String description)	set description of contact
protected void	setID(java.lang.String objectID)
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(java.lang.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(java.lang.String objectName)
void	setStatus(boolean isEnabled)	set the status for the contact
protected void	setType(int objectType)
void	updateAddress(WebSubscriptionAddress wsa)	update address of contact

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreState, restoreXMLState, saveState, saveState, saveState, saveState, saveXMLState

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.utils.StringKey

getStringKey

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionComponent

getDescription, getID, getName, getSessionInfo, getType, isPopulated, populate

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionContact

addAddress, addMember, getAddreses, getAddressesByDeliveryMode, getContactType, getIsAllInfo, getLinkedUserId, getLinkedUserName, getLocationsByDeliveryMode, getMembers, getMemberships, getStatus, getSubscriptions, getSubscriptions, removeAddress, removeMember, setDescription, setIsAllInfo, setLinkedUser, setName, setStatus, updateAddress

Field Detail

DEFAULT_CONTACT_ID

protected static final java.lang.String DEFAULT_CONTACT_ID

See Also:

Constant Field Values

DUMMY_CONTACT_ID

protected static final java.lang.String DUMMY_CONTACT_ID

See Also:

Constant Field Values

_name

protected java.lang.String _name

_id

protected java.lang.String _id

_description

protected java.lang.String _description

_type

protected int _type

_xml

protected java.lang.String _xml

_isPopulated

protected boolean _isPopulated

stale

protected boolean stale

_factory

protected WebObjectsFactory _factory

Method Detail

getMappingDevice

public WebSubscriptionDynamicRecipientList.MappingField getMappingDevice()

Specified by:

getMappingDevice in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Device property is mapping to.

getMappingLinkedUser

public WebSubscriptionDynamicRecipientList.MappingField getMappingLinkedUser()

Specified by:

getMappingLinkedUser in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Linked User property is mapping to.

getMappingNotificationDevice

public WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationDevice()

Specified by:

getMappingNotificationDevice in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Notification Device property is mapping to.

getMappingNotificationAddress

public WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationAddress()

Specified by:

getMappingNotificationAddress in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Notification Address property is mapping to.

getMappingPersonalization

public WebSubscriptionDynamicRecipientList.MappingField getMappingPersonalization()

Specified by:

getMappingPersonalization in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Personalization property is mapping to.

getMappingPhysicalAddress

public WebSubscriptionDynamicRecipientList.MappingField getMappingPhysicalAddress()

Specified by:

getMappingPhysicalAddress in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Physical Address property is mapping to.

getMappingRecipientName

public WebSubscriptionDynamicRecipientList.MappingField getMappingRecipientName()

Specified by:

getMappingRecipientName in interface WebSubscriptionDynamicRecipientList

Returns:

a WebSubscriptionDynamicRecipientList.MappingField object, which the Recipient Name property is mapping to.

setMappingDevice

public void setMappingDevice(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Device property.

Specified by:

setMappingDevice in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingLinkedUser

public void setMappingLinkedUser(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Linked User property.

Specified by:

setMappingLinkedUser in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingNotificationDevice

public void setMappingNotificationDevice(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Notification Device property.

Specified by:

setMappingNotificationDevice in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingNotificationAddress

public void setMappingNotificationAddress(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Notification Address property.

Specified by:

setMappingNotificationAddress in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingPersonalization

public void setMappingPersonalization(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Personalization property.

Specified by:

setMappingPersonalization in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingPhysicalAddress

public void setMappingPhysicalAddress(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Physical Address property.

Specified by:

setMappingPhysicalAddress in interface WebSubscriptionDynamicRecipientList

Parameters:

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

setMappingRecipientName

public void setMappingRecipientName(WebSubscriptionDynamicRecipientList.MappingField field)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping field for Recipient Name property.

Specified by:

setMappingRecipientName in interface WebSubscriptionDynamicRecipientList

Parameters:

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

getMappingContent

public WebObjectInfo getMappingContent()

Specified by:

getMappingContent in interface WebSubscriptionDynamicRecipientList

Returns:

The mapping content object.

getMappingProject

public WebObjectInfo getMappingProject()

Specified by:

getMappingProject in interface WebSubscriptionDynamicRecipientList

Returns:

The project object the mapping content belonging to.

setMappingContent

public void setMappingContent(WebObjectInfo content)

Description copied from interface: WebSubscriptionDynamicRecipientList

Sets the mapping content object.

Specified by:

setMappingContent in interface WebSubscriptionDynamicRecipientList

Parameters:

content - The mapping content object.

setMappingProject

public void setMappingProject(WebObjectInfo project)

Description copied from interface: WebSubscriptionDynamicRecipientList

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

Specified by:

setMappingProject in interface WebSubscriptionDynamicRecipientList

Parameters:

project - The project object.

newMappingField

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

Description copied from interface: WebSubscriptionDynamicRecipientList

Creates a new MappingField object.

Specified by:

newMappingField in interface WebSubscriptionDynamicRecipientList

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

save

public void save()
          throws WebObjectsException

Description copied from interface: WebSubscriptionContact

save this conatct

Specified by:

save in interface EditableObject

Specified by:

save in interface WebSubscriptionContact

Throws:

WebObjectsException - if an error was encountered on the source while saving.

delete

public void delete()
            throws WebObjectsException

Description copied from interface: EditableObject

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

Specified by:

delete in interface EditableObject

Throws:

WebObjectsException - if an error was encountered on the source while deletion.

getSubscriptions

public SimpleList getSubscriptions()
                            throws WebObjectsException

Description copied from interface: WebSubscriptionDynamicRecipientList

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

Specified by:

getSubscriptions in interface WebSubscriptionDynamicRecipientList

Throws:

WebObjectsException

getSubscriptions

public SimpleList getSubscriptions(int blockBegin,
                                   int blockCount)
                            throws WebObjectsException

Throws:

WebObjectsException

getSubscriptions

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

Description copied from interface: WebSubscriptionContact

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.

Specified by:

getSubscriptions in interface WebSubscriptionContact

Parameters:

filter - WebSubscriptionsFilter used to filter the results of this call. A blank filter can be retrieved from WebSubscriptionsSource.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:

SimpleList collection of WebSubscription objects

Throws:

WebObjectsException

save

public void save(java.lang.String iPGUID,
                 java.lang.String iSessionId)
          throws WebObjectsException

Description copied from interface: EditableObject

Saves the new or modified object on its source. Example : saving a WebSchedule on IServer.

Specified by:

save in interface EditableObject

Parameters:

iPGUID - the project Id the object is at

iSessionId - the session Id to access the object on IServer

Throws:

WebObjectsException - if an error was encountered on the source while saving.

getContactType

public int getContactType()

Description copied from interface: WebSubscriptionContact

Returns the type of contact, from EnumDSSXMLSubscriptionContactType

Specified by:

getContactType in interface WebSubscriptionContact

getLinkedUserName

public java.lang.String getLinkedUserName()

Description copied from interface: WebSubscriptionContact

Gets the linked user name of the contact

Specified by:

getLinkedUserName in interface WebSubscriptionContact

Returns:

String full name of the linked user

getLinkedUserId

public java.lang.String getLinkedUserId()

Description copied from interface: WebSubscriptionContact

Gets the linked user Id of the contact

Specified by:

getLinkedUserId in interface WebSubscriptionContact

Returns:

String Id of the linked user

populate

public void populate()

Description copied from interface: WebSubscriptionComponent

used to populate the object if not already populated

Specified by:

populate in interface WebSubscriptionComponent

setIsAllInfo

public void setIsAllInfo(boolean isAllInfo)

Description copied from interface: WebSubscriptionContact

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.

Specified by:

setIsAllInfo in interface WebSubscriptionContact

getIsAllInfo

public boolean getIsAllInfo()

Description copied from interface: WebSubscriptionContact

whether to save all info for the contact

Specified by:

getIsAllInfo in interface WebSubscriptionContact

Returns:

whether to get all info

setStatus

public void setStatus(boolean isEnabled)

Description copied from interface: WebSubscriptionContact

set the status for the contact

Specified by:

setStatus in interface WebSubscriptionContact

getAddressesByDeliveryMode

public SimpleList getAddressesByDeliveryMode(int delMode)
                                      throws WebObjectsException

Description copied from interface: WebSubscriptionContact

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

Specified by:

getAddressesByDeliveryMode in interface WebSubscriptionContact

Parameters:

delMode - , from EnumDSSXMLSubscriptionDeliveryType

Throws:

WebObjectsException

getSubscriptions

public SimpleList getSubscriptions(int deliveryMode)
                            throws WebObjectsException

Description copied from interface: WebSubscriptionContact

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

Specified by:

getSubscriptions in interface WebSubscriptionContact

Parameters:

deliveryMode - , from EnumDSSXMLSubscriptionDeliveryType

Throws:

WebObjectsException

getSubscriptions

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

Description copied from interface: WebSubscriptionContact

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.

Specified by:

getSubscriptions in interface WebSubscriptionContact

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

getLocationsByDeliveryMode

public SimpleList getLocationsByDeliveryMode(int delMode)
                                      throws WebObjectsException

Description copied from interface: WebSubscriptionContact

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

Specified by:

getLocationsByDeliveryMode in interface WebSubscriptionContact

Parameters:

delMode - , from EnumDSSXMLSubscriptionDeliveryType

Throws:

WebObjectsException

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: WebSubscriptionContact

set description of contact

Specified by:

setDescription in interface WebSubscriptionContact

addAddress

public void addAddress(WebSubscriptionAddress address)

Description copied from interface: WebSubscriptionContact

add address of contact

Specified by:

addAddress in interface WebSubscriptionContact

Parameters:

address - WebSubscriptionAddress

updateAddress

public void updateAddress(WebSubscriptionAddress wsa)

Description copied from interface: WebSubscriptionContact

update address of contact

Specified by:

updateAddress in interface WebSubscriptionContact

Parameters:

wsa - WebSubscriptionAddress

removeAddress

public void removeAddress(WebSubscriptionAddress address)
                   throws WebObjectsException

Description copied from interface: WebSubscriptionContact

remove the address of contact

Specified by:

removeAddress in interface WebSubscriptionContact

Parameters:

address - WebSubscriptionAddress

Throws:

WebObjectsException

setLinkedUser

public void setLinkedUser(java.lang.String linkedUserId)

Description copied from interface: WebSubscriptionContact

set the linked User

Specified by:

setLinkedUser in interface WebSubscriptionContact

Parameters:

linkedUserId - the linked User GUID

addCollection

public void addCollection(WebSubscriptionContact collection)

addMember

public void addMember(WebSubscriptionContact member)

Description copied from interface: WebSubscriptionContact

add the members of contact

Specified by:

addMember in interface WebSubscriptionContact

Parameters:

member - WebSubscriptionContact

getMembers

public WebSubscriptionContacts getMembers()

Description copied from interface: WebSubscriptionContact

get the members of the contact

Specified by:

getMembers in interface WebSubscriptionContact

Returns:

WebSubscriptionContacts

removeMember

public void removeMember(WebSubscriptionContact member)
                  throws WebObjectsException

Description copied from interface: WebSubscriptionContact

remove members from the contact

Specified by:

removeMember in interface WebSubscriptionContact

Parameters:

member - the removed members

Throws:

WebObjectsException

getMemberships

public WebSubscriptionContacts getMemberships()

Description copied from interface: WebSubscriptionContact

get the Contact Groups of which the given contact is a member of

Specified by:

getMemberships in interface WebSubscriptionContact

Returns:

WebSubscriptionContacts

getStatus

public boolean getStatus()

Description copied from interface: WebSubscriptionContact

get the status of the contact

Specified by:

getStatus in interface WebSubscriptionContact

getAddreses

public java.util.List<WebSubscriptionAddress> getAddreses()

Description copied from interface: WebSubscriptionContact

get the addresses of contact

Specified by:

getAddreses in interface WebSubscriptionContact

Returns:

List of the addresses of contact

setType

protected void setType(int objectType)

setID

protected void setID(java.lang.String objectID)

setName

public void setName(java.lang.String objectName)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface WebSubscriptionComponent

Returns:

the description of the component

getID

public java.lang.String getID()

Specified by:

getID in interface WebSubscriptionComponent

Returns:

the identifier of the component

getType

public int getType()

Specified by:

getType in interface WebSubscriptionComponent

Returns:

the type of the component as defined in EnumWebSubscriptionObjectTypes

getName

public java.lang.String getName()

Specified by:

getName in interface WebSubscriptionComponent

Returns:

the name of the component

getName

public java.lang.String getName(java.lang.String localeID)

isPopulated

public boolean isPopulated()

Specified by:

isPopulated in interface WebSubscriptionComponent

Returns:

boolean indicating whether the object has been populated

getStringKey

public java.lang.String getStringKey()

Specified by:

getStringKey in interface StringKey

getSessionInfo

public WebSessionInfo getSessionInfo()

Specified by:

getSessionInfo in interface WebSubscriptionComponent

Returns:

the associated WebSessionInfo object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

saveXMLState

protected void saveXMLState(java.lang.StringBuffer buf,
                            int howMuchState)

Overrides:

saveXMLState in class AbstractPersistable

saveXMLState

protected void saveXMLState(WebXMLBuilder builder,
                            int howMuchState)