Package com.microstrategy.web.app.gui
Interface SubscriptionFileWidget
-
- All Superinterfaces:
DefaultSubscriptionWidget
,GuiElement
,SubscriptionWidget
- All Known Subinterfaces:
SubscriptionPrintWidget
- All Known Implementing Classes:
SubscriptionFileWidgetImpl
,SubscriptionPrintWidgetImpl
public interface SubscriptionFileWidget extends SubscriptionWidget
Deprecated.Please use SubscriptionFileWidget from the transforms package.Renders the Widget to create/edit Narrowcast File Subscriptions.- Since:
- MicroStrategy Web 7.5.1
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.gui.SubscriptionWidget
ADDRESS_CONTACT, ADDRESS_EXISTING, ADDRESS_NEW
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getFileName()
Deprecated.java.lang.String
getFileNameArg()
Deprecated.boolean
getIsDeliveryNotificationAvailable()
Deprecated.java.lang.String
getNotificationAddressArg()
Deprecated.SimpleList
getNotificationAddresses()
Deprecated.java.lang.String
getNotificationAddressId()
Deprecated.java.lang.String
getNotificationAddressTypeArg()
Deprecated.java.lang.String
getNotificationDeviceArg()
Deprecated.java.lang.String
getNotificationDeviceId()
Deprecated.SimpleList
getNotificationDevices()
Deprecated.java.lang.String
getNotificationNewAddressArg()
Deprecated.java.lang.String
getNotificationNewAddressValue()
Deprecated.boolean
getUseDeliveryNotification()
Deprecated.java.lang.String
getUseDeliveryNotificationArg()
Deprecated.void
renderAvailableLocations(MarkupOutput out, SimpleList locations, java.lang.String locationID, java.lang.String argLocation)
Deprecated.Renders the list of available locations for the Subscriptions.void
renderNotificationAddressList(MarkupOutput out, SimpleList addresses, java.lang.String addressId, java.lang.String addressArg, java.lang.String addressTypeArg, java.lang.String newAddressValue, java.lang.String newAddressArg, SimpleList devices, java.lang.String deviceId, java.lang.String deviceArg, boolean bUseNotification)
Deprecated.Renders the list of addresses for the Subscription.void
setFileName(java.lang.String value)
Deprecated.Sets the name of the file to which the export will be sent.void
setFileNameArg(java.lang.String value)
Deprecated.The FileName argument name.void
setIsBulkExport(boolean value)
Deprecated.Set to true if the current object is a bulk export report.void
setIsDeliveryNotificationAvailable(boolean value)
Deprecated.Set to true if the feature for creating delivery notification is available.void
setNotificationAddressArg(java.lang.String value)
Deprecated.The name of the adressId argumentvoid
setNotificationAddresses(SimpleList value)
Deprecated.The global list of addresses to use for this subscriptionvoid
setNotificationAddressId(java.lang.String value)
Deprecated.Sets the value of the current addressId used when creating subscriptions to existing addressesvoid
setNotificationAddressTypeArg(java.lang.String value)
Deprecated.The name of the adressType argument.void
setNotificationDeviceArg(java.lang.String value)
Deprecated.The name of the deviceId argument for new addresses.void
setNotificationDeviceId(java.lang.String value)
Deprecated.The current deviceId.void
setNotificationDevices(SimpleList value)
Deprecated.Sets the global list of devices to use for new addressesvoid
setNotificationNewAddressArg(java.lang.String value)
Deprecated.The name of the newAddress argument.void
setNotificationNewAddressValue(java.lang.String value)
Deprecated.The value of the address list used when creating subscriptions to new addressesvoid
setUseDeliveryNotification(boolean value)
Deprecated.Set to true if delivery notification is currently used.void
setUseDeliveryNotificationArg(java.lang.String value)
Deprecated.The name of the useDeliveryNotification argument.-
Methods inherited from interface com.microstrategy.web.app.gui.DefaultSubscriptionWidget
getAddressArg, getAddresses, getAddressId, getAddressTypeArg, getAvailableFormats, getAvailableLocations, getChangeableMask, getCompressed, getCompressedArg, getCompressedFileName, getCompressedFileNameArg, getCurrentFormat, getCustomMessage, getCustomMessageArg, getDeviceArg, getDeviceId, getDevices, getExpandPageBy, getExpandPageByArg, getExpandUseSeparateSheets, getExpandUseSeparateSheetsArg, getExpirationDate, getFormatArg, getImageBasePath, getInitialiIndent, getIsCreateEmailAvailable, getIsCustomMessageAvailable, getIsExpandPageByAvailable, getIsRWD, getLocationArg, getLocationID, getNewAddressArg, getNewAddressValue, getObjectName, getOpenAddressesEvent, getSubject, getSubjectArg, getSubscriptionObjectType, getSubscriptionObjectViewType, getZipPassword, isIncludeDataSet, isIncludeLinkSet, isProtectZipFile, isSendToInboxSet, renderAddressList, renderCustomMessageField, renderObjectName, renderSubjectField, setAddressArg, setAddresses, setAddressId, setAddressTypeArg, setAllowChangeDeliverySettingsArg, setAllowChangePersonalizationArg, setAllowUnsubscribeArg, setAvailableFormats, setAvailableLocations, setChangeableMask, setCompressed, setCompressedArg, setCompressedFileName, setCompressedFileNameArg, setCurrentFormat, setCustomMessage, setCustomMessageArg, setDeviceArg, setDeviceId, setDevices, setExpandPageBy, setExpandPageByArg, setExpandUseSeparateSheets, setExpandUseSeparateSheetsArg, setExpirationDate, setExpirationDateArg, setFormatArg, setImageBasePath, setIncludeData, setIncludeDataArg, setIncludeLink, setIncludeLinkArg, setInitialiIndent, setIsCreateEmailAvailable, setIsCustomMessageAvailable, setIServerAsNCSSource, setIsExpandPageByAvailable, setIsRWD, setLocationArg, setLocationID, setNewAddressArg, setNewAddressValue, setObjectName, setOpenAddressesEvent, setOpenContactsBrowser, setOpenContactsBrowserEvent, setProtectZipFile, setProtectZipFileArg, setSendToInbox, setSendToInboxArg, setSubject, setSubjectArg, setSubscriptionObjectType, setSubscriptionObjectViewType, setZipPassword, setZipPasswordArg
-
Methods inherited from interface com.microstrategy.web.app.gui.GuiElement
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent
-
Methods inherited from interface com.microstrategy.web.app.gui.SubscriptionWidget
getIsSendNowAvailable, getSendNowArg, getTriggerArg, getTriggerId, getTriggers, isSendNowSet, renderTriggerList, setIsSendNowAvailable, setSendNow, setSendNowArg, setTriggerArg, setTriggerId, setTriggers
-
-
-
-
Method Detail
-
setIsBulkExport
void setIsBulkExport(boolean value)
Deprecated.Set to true if the current object is a bulk export report.- Parameters:
value
- true current object is a bulk export report.- Since:
- MicroStrategy Web 8.0.0
-
renderAvailableLocations
void renderAvailableLocations(MarkupOutput out, SimpleList locations, java.lang.String locationID, java.lang.String argLocation)
Deprecated.Renders the list of available locations for the Subscriptions. This method can be called stand alone by passing the required arguments. It's also part of therenderElement()
method that passes the global widget values properties as the arguments.- Parameters:
out
- Where to write the widget's outputlocations
- the list of locationslocationID
- the current location IDargLocation
- the name of the location ID argument
-
renderNotificationAddressList
void renderNotificationAddressList(MarkupOutput out, SimpleList addresses, java.lang.String addressId, java.lang.String addressArg, java.lang.String addressTypeArg, java.lang.String newAddressValue, java.lang.String newAddressArg, SimpleList devices, java.lang.String deviceId, java.lang.String deviceArg, boolean bUseNotification)
Deprecated.Renders the list of addresses for the Subscription. This method can be called stand alone by passing the required arguments. It's also part of therenderElement()
method that passes the global widget values properties as the arguments.- Parameters:
out
- Where to write the widget's outputaddresses
- the list of addressesaddressId
- the id of the current addressaddressArg
- the name of the addressId argaddressTypeArg
- the name of the addressType argnewAddressValue
- the value for the new address listnewAddressArg
- the name of the new address list argumentdevices
- the list of devicesdeviceId
- the current deviceIddeviceArg
- the name of the deviceId argumentbUseNotification
- the boolean argument to denote whether the subscription uses notification- Since:
- MicroStrategy Web 8.0.0
-
setNotificationDevices
void setNotificationDevices(SimpleList value)
Deprecated.Sets the global list of devices to use for new addresses- Parameters:
value
- the new list of devices.- Since:
- MicroStrategy Web 8.0.0
-
getNotificationDevices
SimpleList getNotificationDevices()
Deprecated.- Returns:
- the current global list of devices.
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationAddresses
void setNotificationAddresses(SimpleList value)
Deprecated.The global list of addresses to use for this subscription- Parameters:
value
- the new global list of addresses- Since:
- MicroStrategy Web 8.0.0
-
getNotificationAddresses
SimpleList getNotificationAddresses()
Deprecated.- Returns:
- the current global list of addresses
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationAddressId
void setNotificationAddressId(java.lang.String value)
Deprecated.Sets the value of the current addressId used when creating subscriptions to existing addresses- Parameters:
value
- the new addressId- Since:
- MicroStrategy Web 8.0.0
-
getNotificationAddressId
java.lang.String getNotificationAddressId()
Deprecated.- Returns:
- the value of the current addressId used when creating subscriptions to existing addresses
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationNewAddressValue
void setNotificationNewAddressValue(java.lang.String value)
Deprecated.The value of the address list used when creating subscriptions to new addresses- Parameters:
value
- a comma separated list of addresses- Since:
- MicroStrategy Web 8.0.0
-
getNotificationNewAddressValue
java.lang.String getNotificationNewAddressValue()
Deprecated.- Returns:
- a comma separated list of addresses used when creating subscriptions to new addresses
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationDeviceId
void setNotificationDeviceId(java.lang.String value)
Deprecated.The current deviceId. This is the device used for new addresses- Parameters:
value
- the new current deviceId- Since:
- MicroStrategy Web 8.0.0
-
getNotificationDeviceId
java.lang.String getNotificationDeviceId()
Deprecated.- Returns:
- The current deviceId. This is the device used for new addresses
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationAddressArg
void setNotificationAddressArg(java.lang.String value)
Deprecated.The name of the adressId argument- Parameters:
value
- the new name for the addressId argument- Since:
- MicroStrategy Web 8.0.0
-
getNotificationAddressArg
java.lang.String getNotificationAddressArg()
Deprecated.- Returns:
- The name of the addressId argument
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationAddressTypeArg
void setNotificationAddressTypeArg(java.lang.String value)
Deprecated.The name of the adressType argument. The addressType indicates whether to use an existing addresses or a new address list- Parameters:
value
- the new name for the addressType argument.- Since:
- MicroStrategy Web 8.0.0
-
getNotificationAddressTypeArg
java.lang.String getNotificationAddressTypeArg()
Deprecated.- Returns:
- the name for the addressType argument.
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationDeviceArg
void setNotificationDeviceArg(java.lang.String value)
Deprecated.The name of the deviceId argument for new addresses.- Parameters:
value
- the new deviceId argument name.- Since:
- MicroStrategy Web 8.0.0
-
getNotificationDeviceArg
java.lang.String getNotificationDeviceArg()
Deprecated.- Returns:
- The deviceId argument name for new addresses.
- Since:
- MicroStrategy Web 8.0.0
-
setNotificationNewAddressArg
void setNotificationNewAddressArg(java.lang.String value)
Deprecated.The name of the newAddress argument.- Parameters:
value
- the new newAddress argument name- Since:
- MicroStrategy Web 8.0.0
-
getNotificationNewAddressArg
java.lang.String getNotificationNewAddressArg()
Deprecated.- Returns:
- the newAddress argument name
- Since:
- MicroStrategy Web 8.0.0
-
setUseDeliveryNotification
void setUseDeliveryNotification(boolean value)
Deprecated.Set to true if delivery notification is currently used.- Parameters:
value
- true if delivery notification is currently used.- Since:
- MicroStrategy Web 8.0.0
-
getUseDeliveryNotification
boolean getUseDeliveryNotification()
Deprecated.- Returns:
- true if delivery notification is currently used.
- Since:
- MicroStrategy Web 8.0.0
-
setUseDeliveryNotificationArg
void setUseDeliveryNotificationArg(java.lang.String value)
Deprecated.The name of the useDeliveryNotification argument.- Parameters:
value
- the new useDeliveryNotification argument name.- Since:
- MicroStrategy Web 8.0.0
-
getUseDeliveryNotificationArg
java.lang.String getUseDeliveryNotificationArg()
Deprecated.- Returns:
- The useDeliveryNotification argument name.
- Since:
- MicroStrategy Web 8.0.0
-
setIsDeliveryNotificationAvailable
void setIsDeliveryNotificationAvailable(boolean value)
Deprecated.Set to true if the feature for creating delivery notification is available.- Parameters:
value
- true if the feature for creating new email addresses is available.- Since:
- MicroStrategy Web 8.0.0
-
getIsDeliveryNotificationAvailable
boolean getIsDeliveryNotificationAvailable()
Deprecated.- Returns:
- true if the feature for creating delivery notification is available.
- Since:
- MicroStrategy Web 8.0.0
-
setFileName
void setFileName(java.lang.String value)
Deprecated.Sets the name of the file to which the export will be sent.- Specified by:
setFileName
in interfaceDefaultSubscriptionWidget
- Parameters:
value
- the name of the file to which the export will be sent.
-
getFileName
java.lang.String getFileName()
Deprecated.- Specified by:
getFileName
in interfaceDefaultSubscriptionWidget
- Returns:
- the name of the file to which the export will be sent.
-
setFileNameArg
void setFileNameArg(java.lang.String value)
Deprecated.The FileName argument name.- Specified by:
setFileNameArg
in interfaceDefaultSubscriptionWidget
- Parameters:
value
- The FileName argument name.
-
getFileNameArg
java.lang.String getFileNameArg()
Deprecated.- Specified by:
getFileNameArg
in interfaceDefaultSubscriptionWidget
- Returns:
- The FileName argument name.
-
-