Package com.microstrategy.web.objects

Interface WebSubscriptionDynamicRecipientList

All Superinterfaces:

EditableObject, EnumWebPersistableState, Persistable, StringKey, WebSubscriptionComponent, WebSubscriptionContact

All Known Implementing Classes:

WebIServerSubscriptionDynamicRecipientListImpl

public interface WebSubscriptionDynamicRecipientList
extends WebSubscriptionContact, EditableObject

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebSubscriptionDynamicRecipientList.MappingField

Field Summary

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

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
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()
SimpleList	getSubscriptions()	Returns a SimpleList collection of WebSubscription objects to which this DRL (dynamic recipient list) is subscribed to
WebSubscriptionDynamicRecipientList.MappingField	newMappingField(java.lang.String attributeId, java.lang.String formId)	Creates a new MappingField object.
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.

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

delete, save, save

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, getSubscriptions, removeAddress, removeMember, save, setDescription, setIsAllInfo, setLinkedUser, setName, setStatus, updateAddress

Method Detail

newMappingField

WebSubscriptionDynamicRecipientList.MappingField newMappingField(java.lang.String attributeId,
                                                                 java.lang.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

getMappingProject

WebObjectInfo getMappingProject()

Returns:

The project object the mapping content belonging to.

getMappingContent

WebObjectInfo getMappingContent()

Returns:

The mapping content object.

setMappingProject

void setMappingProject(WebObjectInfo project)

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

Parameters:

project - The project object.

setMappingContent

void setMappingContent(WebObjectInfo content)

Sets the mapping content object.

Parameters:

content - The mapping content object.

getMappingPhysicalAddress

WebSubscriptionDynamicRecipientList.MappingField getMappingPhysicalAddress()

Returns:

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

setMappingPhysicalAddress

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

getMappingLinkedUser

WebSubscriptionDynamicRecipientList.MappingField getMappingLinkedUser()

Returns:

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

setMappingLinkedUser

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

getMappingDevice

WebSubscriptionDynamicRecipientList.MappingField getMappingDevice()

Returns:

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

setMappingDevice

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

getMappingRecipientName

WebSubscriptionDynamicRecipientList.MappingField getMappingRecipientName()

Returns:

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

setMappingRecipientName

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

getMappingNotificationAddress

WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationAddress()

Returns:

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

setMappingNotificationAddress

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

getMappingNotificationDevice

WebSubscriptionDynamicRecipientList.MappingField getMappingNotificationDevice()

Returns:

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

setMappingNotificationDevice

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

getMappingPersonalization

WebSubscriptionDynamicRecipientList.MappingField getMappingPersonalization()

Returns:

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

setMappingPersonalization

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

getSubscriptions

SimpleList getSubscriptions()
                     throws WebObjectsException

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

Throws:

WebObjectsException

Since:

MicroStrategy Web 10.4