Package com.microstrategy.web.objects

Interface WebDevice

All Superinterfaces:

KeyedObject, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

All Known Implementing Classes:

WebEmailDeviceImpl, WebFileDeviceImpl, WebFTPDeviceImpl, WebMobileDeviceImpl, WebPrinterDeviceImpl

public interface WebDevice
extends WebObjectInfo

Method Summary

Modifier and Type	Method	Description
void	delete()	To delete a existing device.
int	getTransmissionType()	To get the transmission type of the device
WebTransmitter	getTransmitter()	To get the transmitter refered by this device
boolean	IsSupportExcelFormat()	To check if the device support excel format
boolean	IsSupportHTMLFormat()	To check if the device support HTML format
boolean	IsSupportHTMLImages()	To check if the device support HTML images
boolean	IsSupportPDFFormat()	To check if the device support PDF format
boolean	IsSupportPlaintextFormat()	To check if the device support plain text format
void	save()	To save a new/existing device, don't overwrite
void	save(boolean overwrite)	To save a new/existing device
void	setSupportExcelFormat(boolean flag)	To set the device to support excel format
void	setSupportHTMLFormat(boolean flag)	To set the device to support HTML format
void	setSupportHTMLImages(boolean flag)	To set the device to support HTML images
void	setSupportPDFFormat(boolean flag)	To set the device support PDF format
void	setSupportPlaintextFormat(boolean flag)	To set the device to support plain text format
void	setTransmissionType(int type)	To set the transmission type of the device
void	setTransmitter(WebTransmitter transmitter)	To set the transmitter refered by this device

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

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

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

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

isFeatureAvailable, isFeatureAvailable

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

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

getPromptInstances

Method Detail

getTransmissionType

int getTransmissionType()

To get the transmission type of the device

setTransmissionType

void setTransmissionType(int type)

To set the transmission type of the device

Parameters:

type - . Type of transmission, This value comes from EnumDSSXMLSubscriptionDeliveryType

IsSupportPlaintextFormat

boolean IsSupportPlaintextFormat()

To check if the device support plain text format

setSupportPlaintextFormat

void setSupportPlaintextFormat(boolean flag)

To set the device to support plain text format

Parameters:

flag - . True to support, false to not.

IsSupportHTMLFormat

boolean IsSupportHTMLFormat()

To check if the device support HTML format

setSupportHTMLFormat

void setSupportHTMLFormat(boolean flag)

To set the device to support HTML format

Parameters:

flag - . True to support, false to not.

IsSupportHTMLImages

boolean IsSupportHTMLImages()

To check if the device support HTML images

setSupportHTMLImages

void setSupportHTMLImages(boolean flag)

To set the device to support HTML images

Parameters:

flag - . True to support, false to not.

IsSupportExcelFormat

boolean IsSupportExcelFormat()

To check if the device support excel format

setSupportExcelFormat

void setSupportExcelFormat(boolean flag)

To set the device to support excel format

Parameters:

flag - . True to support, false to not.

IsSupportPDFFormat

boolean IsSupportPDFFormat()

To check if the device support PDF format

setSupportPDFFormat

void setSupportPDFFormat(boolean flag)

To set the device support PDF format

Parameters:

flag - . True to support, false to not.

getTransmitter

WebTransmitter getTransmitter()

To get the transmitter refered by this device

Returns:

the refered transmitter.

setTransmitter

void setTransmitter(WebTransmitter transmitter)

To set the transmitter refered by this device

Parameters:

transmitter - . An instance of transmitter refered transmitter.

save

void save()
   throws WebObjectsException

To save a new/existing device, don't overwrite

Throws:

WebObjectsException

save

void save(boolean overwrite)
   throws WebObjectsException

To save a new/existing device

Throws:

WebObjectsException

delete

void delete()
     throws WebObjectsException

To delete a existing device.

Throws:

WebObjectsException