java.lang.Object
- com.microstrategy.utils.serialization.AbstractPersistable
- - com.microstrategy.web.objects.WebFileDeviceImpl

All Implemented Interfaces:

KeyedObject, EnumWebPersistableState, Persistable, EnumWebObjectsFeatures, WebDevice, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite, EnumDSSXMLAccessRightFlags
```
public class WebFileDeviceImpl
extends AbstractPersistable
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.lang.String`	`DELIMITER`
`protected java.lang.String`	`deliverySettings`
`protected static java.lang.String`	`PROPERTY_SEPERATOR`
`protected static java.lang.String`	`PROPERTY_VALUE_SEPERATOR`
`protected static java.lang.String`	`SUPPORTED_FORMAT_TYPES`
`protected WebTransmitter`	`transmitter`

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

Fields inherited from interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags
DssXmlAccessRightBrowse, DssXmlAccessRightControl, DssXmlAccessRightDelete, DssXmlAccessRightExecute, DssXmlAccessRightFullControl, DssXmlAccessRightInheritable, DssXmlAccessRightRead, DssXmlAccessRightUse, DssXmlAccessRightUseExecute, DssXmlAccessRightWrite

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Constructor Summary

Constructors
Constructor Description

WebFileDeviceImpl(WebObjectsFactory _factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`_getObKey()`
`void`	`addDetails(boolean details)`	This method will add or remove details from the display unit.
`protected java.lang.String`	`addProperty(java.lang.String property, boolean value)`
`protected java.lang.String`	`addProperty(java.lang.String property, int value)`
`protected java.lang.String`	`addProperty(java.lang.String property, java.lang.String value)`
`void`	`applyVisitor(DisplayUnitsVisitor visitor, boolean deep)`
`void`	`buildShortObjectAttributes(WebXMLBuilder builder)`
`void`	`buildShortXML(WebXMLBuilder builder)`
`boolean`	`canHighlight()`
`protected boolean`	`checkAccessFlags(int flags)`
`protected boolean`	`checkAccessRights(java.lang.String feature)`
`protected boolean`	`checkPrivilege(java.lang.String feature)`
`protected com.microstrategy.web.objects.WebOIDisplayXMLHandler`	`createDisplayXMLHandler()`
`protected com.microstrategy.web.objects.WebOIDOMHandler`	`createDOMHandler()`
`protected com.microstrategy.web.objects.WebOISAXParser`	`createSAXParser()`
`protected com.microstrategy.web.objects.WebOIXMLBuilder`	`createXMLBuilder()`
`void`	`delete()`	To delete a existing device.
`protected void`	`doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)`
`boolean`	`equals(WebObjectInfo otherOI)`
`boolean`	`equals(java.lang.Object otherObject)`
`protected java.lang.String`	`generateTransformationSettings()`
`java.lang.String`	`getAbbreviation()`	Returns the abbreviation of this object.
`int`	`getAccessGranted()`	Returns the current access granted on this object, if available.
`SimpleList`	`getAncestors()`	Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
`java.lang.String`	`getBackUpLocation()`
`int`	`getCardStatus()`	Returns the status of the hyper card.
`WebCertifiedInfo`	`getCertifiedInfo()`
`WebDisplayUnits`	`getChildUnits()`	Returns the collection of child display units, or null if the object is not a collection.
`java.lang.String[]`	`getComments()`	Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
`java.lang.String`	`getContainerDid()`
`java.lang.String`	`getContainerType()`
`java.lang.String`	`getCreationTime()`	Returns the creation time of this object, if that information is available.
`long`	`getCreationTimeStamp()`	Get the object creation timestamp in millisecond.
`java.lang.String`	`getDataSources()`
`java.lang.String`	`getDefaultLanguage()`
`int`	`getDeliveryTimeout()`
`java.util.Map<java.lang.String,java.lang.String>`	`getDescMap()`
`java.lang.String`	`getDescription()`	Returns the description of the object.
`int`	`getDeviceEncryptionLevel()`
`java.lang.String`	`getDisplayName()`	Returns the display name associated with this object.
`int`	`getDisplayUnitType()`	Returns the type of display unit that this object represents.
`java.lang.String`	`getDisplayXML()`
`int`	`getExtendedType()`	The current extended type
`protected java.lang.String`	`getExtParams()`
`WebObjectsFactory`	`getFactory()`	Returns WebObjectsFactory
`int`	`getFlags()`	Returns the flags which determine what data to populate upon calling populate.
`java.lang.String`	`getIconPath()`	Return the icon path for the object
`java.lang.String`	`getID()`	Returns the DSS ID of the object, if one exists.
`java.lang.String`	`getLocation()`
`java.lang.String`	`getModificationTime()`	Returns the last modification time of the object, if that information is available.
`long`	`getModificationTimeStamp()`	Get the object modification timestamp in millisecond.
`java.lang.String`	`getMountRoot()`
`java.lang.String`	`getName()`	Returns the name of this object.
`java.util.Map<java.lang.String,java.lang.String>`	`getNameMap()`
`boolean`	`getNonSchedulable()`	Get flag of whether the object is not schedulable
`int`	`getNumberOfRetries()`
`int`	`getOtherNameTransCount()`	Returns the count of name translations for locales other than the current effective locale.
`WebObjectInfo`	`getOwner()`	Returns a WebObjectInfo object which corresponds to the owner of this object.
`WebFolder`	`getParent()`	Returns the parent folder of the current object, if it exists.
`java.lang.String`	`getPassword()`
`int`	`getPreferredEncryptionLevel()`
`int`	`getPreSaveAsFlags()`	Returns the flags which determine the previous save as prompt flag.
`java.lang.String`	`getProjectId()`
`java.lang.String`	`getProjectName()`
`WebPromptInstances`	`getPromptInstances()`	Returns a collection of prompt instances from this prompt site.
`int`	`getPropertyFlags()`	Retrieve the current property flags
`SimpleList`	`getPropertySetFilter()`	Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
`WebPropertyGroup`	`getPropertySets()`	Returns the property sets associated with this object.
`WebRecommendationInfo`	`getRecommendationInfo()`	This contains all the information related to a recommendation search
`WebObjectSecurity`	`getSecurity()`	Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
`int`	`getSelectedCount()`
`int`	`getState()`	Returns the state of the object.
`int`	`getSubType()`	Returns the subtype of the object.
`WebTemplateInfo`	`getTemplateInfo()`
`int`	`getTimeBetweenRetries()`
`int`	`getTransmissionType()`	To get the transmission type of the device
`WebTransmitter`	`getTransmitter()`	To get the transmitter refered by this device
`int`	`getType()`	Returns the type of this object.
`java.lang.String`	`getUnixAccessRights()`
`java.lang.String`	`getUserName()`
`java.lang.String`	`getVersionID()`	Returns the Version ID of the object, if one exists.
`WebViewMediaSettings`	`getViewMediaSettings()`
`int`	`getVisualizationViewMode()`
`java.lang.String`	`getXML()`	Returns the XML representation of this object.
`java.lang.String`	`getXML(boolean encode)`	Returns the XML representation of this object.
`protected java.lang.String`	`getXMLForSave()`
`protected void`	`handleOiBody(SAXSupport parser, java.lang.String local, org.xml.sax.Attributes attrs)`
`protected void`	`handleOiEnd(SAXSupport parser, java.lang.String local, java.lang.String buf)`
`boolean`	`hasDetails()`	Returns whether this display unit currently has details enabled.
`int`	`hashCode()`
`boolean`	`hasOwner()`
`void`	`highlightUnit()`	Sets this display unit to be highlighted.
`void`	`highlightUnit(boolean details)`	Sets this display unit to be highlighted.
`boolean`	`isAncestorNamedFolder(int folderName)`	Returns whether the named folder is this object's ancestor.
`boolean`	`isAppendTimestampToFileName()`
`boolean`	`isAppendToFile()`
`boolean`	`isAppendUserPath()`
`protected boolean`	`isBodyDirty()`
`boolean`	`isCreateFolders()`
`boolean`	`isDirty()`	Returns whether this object has been modified to be different from the object in metadata.
`boolean`	`isEmbedded()`
`boolean`	`isEnableUnixToWindows()`
`boolean`	`isFeatureAvailable(java.lang.String feature)`	Returns whether the given feature is available or not.
`boolean`	`isFeatureAvailable(java.lang.String feature, java.lang.Object dependencyObject)`	Returns whether the given feature is available or not.
`boolean`	`isFileArchive()`
`boolean`	`isFileCompress()`
`boolean`	`isFileEncrypt()`
`boolean`	`isFileIndex()`
`boolean`	`isFileReadOnly()`
`boolean`	`isHidden()`	Returns whether the object is a hidden object.
`boolean`	`isHighlighted()`	Returns whether this unit is highlighted.
`boolean`	`isNew()`	Returns whether this object is newly created at client side, which is not in the metadata.
`boolean`	`isObjectInfo()`	Returns true if underlying Web Object can be cast to `WebObjectInfo`.
`boolean`	`isOverwriteFiles()`
`boolean`	`isPopulated()`	Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
`boolean`	`isSelected()`	Returns whether this display unit is selected.
`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
`boolean`	`isUseBackUpLocation()`
`protected boolean`	`performIncrFetchLocally()`	Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
`void`	`populate()`	Populates the fields on this object by asking the Intelligence Server for the object definition.
`void`	`populate(java.lang.String xml)`	Populates the fields on this object by loading the given object definition XML.
`protected void`	`postProcessOi(com.microstrategy.web.objects.WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)`
`void`	`restoreSettings()`
`void`	`save()`	To save a new/existing device, don't overwrite
`void`	`save(boolean overwrite)`	To save a new/existing device
`protected void`	`saveXMLState(WebXMLBuilder builder, int howMuchState)`
`protected void`	`saveXMLState(java.lang.StringBuffer buf, int howMuchState)`
`void`	`setAbbreviation(java.lang.String ab)`
`void`	`setAppendTimestampToFileName(boolean appendTimestampToFileName)`
`void`	`setAppendToFile(boolean appendToFile)`
`void`	`setAppendUserPath(boolean appendUserPath)`
`void`	`setBackUpLocation(java.lang.String backUpLocation)`
`void`	`setCardStatus(int cardStatus)`
`void`	`setCertifiedInfo(WebCertifiedInfo certifiedInfo)`
`void`	`setComments(java.lang.String[] _comments)`	Set the long description of the object as an array of strings.
`void`	`setCreateFolders(boolean createFolders)`
`void`	`setDataSources(java.lang.String dsXML)`
`void`	`setDefaultLanguage(java.lang.String defaultLanguage)`
`void`	`setDeliverySettings(java.lang.String dlss)`
`void`	`setDeliveryTimeout(int deliveryTimeout)`
`protected void`	`setDescMap(java.util.Map<java.lang.String,java.lang.String> _descMap)`
`void`	`setDescription(java.lang.String _description)`	Sets the description of the object.
`void`	`setDeviceEncryptionLevel(int deviceEncryptionLevel)`
`void`	`setDisplayName(java.lang.String _displayName)`	This method will set the value of the display name.
`void`	`setEnableUnixToWindows(boolean enableUnixToWindows)`
`void`	`setExtendedType(int extendedType)`	Set the current extended type
`void`	`setFileArchive(boolean fileArchive)`
`void`	`setFileCompress(boolean fileCompress)`
`void`	`setFileEncrypt(boolean fileEncrypt)`
`void`	`setFileIndex(boolean fileIndex)`
`void`	`setFileReadOnly(boolean fileReadOnly)`
`void`	`setFlags(int _flags)`	Sets the flags which determine what data to populate upon calling populate.
`void`	`setHidden(boolean hid)`	Sets whether the object is a hidden object.
`void`	`setIconPath(java.lang.String iconPath)`	Set the icon path for the object
`void`	`setLocation(java.lang.String location)`
`void`	`setMountRoot(java.lang.String mountRoot)`
`void`	`setName(java.lang.String _name)`
`protected void`	`setNameMap(java.util.Map<java.lang.String,java.lang.String> _nameMap)`
`void`	`setNonSchedulable(boolean non_schedulable)`	Set flag of whether the object is not schedulable
`void`	`setNumberOfRetries(int numberOfRetries)`
`void`	`setOverwriteFiles(boolean overwriteFiles)`
`void`	`setPassword(java.lang.String p)`
`void`	`setPreferredEncryptionLevel(int preferredEncryptionLevel)`
`void`	`setPreSaveAsFlags(int flags)`	Sets the flags which determine the previous save as prompt flag.
`void`	`setProjectId(java.lang.String projectId)`
`void`	`setPropertyFlags(int flags)`	Set the current property flags
`void`	`setRecommendationInfo(WebRecommendationInfo recommendationInfo)`
`void`	`setSelected(boolean selected)`	Sets the current unit's selection status.
`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`	`setTemplateInfo(WebTemplateInfo templateInfo)`
`void`	`setTimeBetweenRetries(int timeBetweenRetries)`
`void`	`setTransformationSettings(java.lang.String tfss)`
`void`	`setTransmissionType(int type)`	To set the transmission type of the device
`void`	`setTransmitter(WebTransmitter transmitter)`	To set the transmitter refered by this device
`void`	`setTransmitter(java.lang.String transmitterID)`
`void`	`setTransmitterName(java.lang.String name)`
`void`	`setUnixAccessRights(java.lang.String unixAccessRights)`
`void`	`setUseBackUpLocation(boolean useBackUpLocation)`
`void`	`setUserName(java.lang.String u)`
`java.lang.String`	`toString()`

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable
doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreState, restoreXMLState, saveState, saveState, saveState, saveState, saveXMLState

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDefaultLanguage, setExtendedType, setFlags, setHidden, setIconPath, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

- Field Detail
  - transmitter
```
protected WebTransmitter transmitter
```
  - deliverySettings
```
protected java.lang.String deliverySettings
```
  - SUPPORTED_FORMAT_TYPES
```
protected static final java.lang.String SUPPORTED_FORMAT_TYPES
```
    See Also:
    
    Constant Field Values
  - PROPERTY_SEPERATOR
```
protected static final java.lang.String PROPERTY_SEPERATOR
```
    See Also:
    
    Constant Field Values
  - PROPERTY_VALUE_SEPERATOR
```
protected static final java.lang.String PROPERTY_VALUE_SEPERATOR
```
    See Also:
    
    Constant Field Values
  - DELIMITER
```
protected static final java.lang.String DELIMITER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WebFileDeviceImpl
```
public WebFileDeviceImpl(WebObjectsFactory _factory)
```
- Method Detail
  - isAppendTimestampToFileName
```
public boolean isAppendTimestampToFileName()
```
  - setAppendTimestampToFileName
```
public void setAppendTimestampToFileName(boolean appendTimestampToFileName)
```
  - isAppendToFile
```
public boolean isAppendToFile()
```
  - setAppendToFile
```
public void setAppendToFile(boolean appendToFile)
```
  - isAppendUserPath
```
public boolean isAppendUserPath()
```
  - setAppendUserPath
```
public void setAppendUserPath(boolean appendUserPath)
```
  - isCreateFolders
```
public boolean isCreateFolders()
```
  - setCreateFolders
```
public void setCreateFolders(boolean createFolders)
```
  - isOverwriteFiles
```
public boolean isOverwriteFiles()
```
  - setOverwriteFiles
```
public void setOverwriteFiles(boolean overwriteFiles)
```
  - isUseBackUpLocation
```
public boolean isUseBackUpLocation()
```
  - setUseBackUpLocation
```
public void setUseBackUpLocation(boolean useBackUpLocation)
```
  - isFileArchive
```
public boolean isFileArchive()
```
  - setFileArchive
```
public void setFileArchive(boolean fileArchive)
```
  - isFileCompress
```
public boolean isFileCompress()
```
  - setFileCompress
```
public void setFileCompress(boolean fileCompress)
```
  - isFileEncrypt
```
public boolean isFileEncrypt()
```
  - setFileEncrypt
```
public void setFileEncrypt(boolean fileEncrypt)
```
  - isFileIndex
```
public boolean isFileIndex()
```
  - setFileIndex
```
public void setFileIndex(boolean fileIndex)
```
  - isFileReadOnly
```
public boolean isFileReadOnly()
```
  - setFileReadOnly
```
public void setFileReadOnly(boolean fileReadOnly)
```
  - getLocation
```
public java.lang.String getLocation()
```
  - setLocation
```
public void setLocation(java.lang.String location)
```
  - getBackUpLocation
```
public java.lang.String getBackUpLocation()
```
  - setBackUpLocation
```
public void setBackUpLocation(java.lang.String backUpLocation)
```
  - getUnixAccessRights
```
public java.lang.String getUnixAccessRights()
```
  - setUnixAccessRights
```
public void setUnixAccessRights(java.lang.String unixAccessRights)
```
  - getDeliveryTimeout
```
public int getDeliveryTimeout()
```
  - setDeliveryTimeout
```
public void setDeliveryTimeout(int deliveryTimeout)
```
  - getNumberOfRetries
```
public int getNumberOfRetries()
```
  - setNumberOfRetries
```
public void setNumberOfRetries(int numberOfRetries)
```
  - getTimeBetweenRetries
```
public int getTimeBetweenRetries()
```
  - setTimeBetweenRetries
```
public void setTimeBetweenRetries(int timeBetweenRetries)
```
  - isEnableUnixToWindows
```
public boolean isEnableUnixToWindows()
```
  - setEnableUnixToWindows
```
public void setEnableUnixToWindows(boolean enableUnixToWindows)
```
  - getPassword
```
public java.lang.String getPassword()
```
  - setPassword
```
public void setPassword(java.lang.String p)
```
  - getUserName
```
public java.lang.String getUserName()
```
  - setUserName
```
public void setUserName(java.lang.String u)
```
  - getMountRoot
```
public java.lang.String getMountRoot()
```
  - setMountRoot
```
public void setMountRoot(java.lang.String mountRoot)
```
  - getDeviceEncryptionLevel
```
public int getDeviceEncryptionLevel()
```
  - setDeviceEncryptionLevel
```
public void setDeviceEncryptionLevel(int deviceEncryptionLevel)
```
  - getPreferredEncryptionLevel
```
public int getPreferredEncryptionLevel()
```
  - setPreferredEncryptionLevel
```
public void setPreferredEncryptionLevel(int preferredEncryptionLevel)
```
  - addProperty
```
protected java.lang.String addProperty(java.lang.String property,
                                       java.lang.String value)
```
  - addProperty
```
protected java.lang.String addProperty(java.lang.String property,
                                       boolean value)
```
  - addProperty
```
protected java.lang.String addProperty(java.lang.String property,
                                       int value)
```
  - setName
```
public void setName(java.lang.String _name)
```
    Specified by:
    
    setName in interface WebObjectInfo
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: WebObjectInfo
    
    Returns the name of this object. the name retrieved with this method is read-only on this interface, comes from the MetaData name of a first-class object. If you wish to change the name displayed to the screen, WebDisplayUnit.setDisplayName(java.lang.String) should be used along with the WebDisplayUnit.getDisplayName() call. Please also note that while only first-class objects (i.e. WebObjectInfo) has a "name" property, many object types (WebElements, and WebDimtyUnit) can have their respective "names" accessed or changed on the screen via WebDisplayUnit.getDisplayName() and WebDisplayUnit.setDisplayName(java.lang.String). If you want to change the object's actual metadata name, it can be done via the appropriate WebObjectSource.save(WebObjectInfo, String) or WebObjectSource.save(WebObjectInfo, String, WebFolder) calls.
    
    Specified by:
    
    getName in interface WebObjectInfo
    
    Returns:
    
    The name of the object.
  - setDescription
```
public void setDescription(java.lang.String _description)
```
    Description copied from interface: WebObjectInfo
    
    Sets the description of the object. The object must be saved by the save or copy methods on the WebObjectSource object to cause a change to this object to be saved.
    
    Specified by:
    
    setDescription in interface WebObjectInfo
    
    Parameters:
    
    _description - The description for the object.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: WebObjectInfo
    
    Returns the description of the object.
    
    Specified by:
    
    getDescription in interface WebObjectInfo
    
    Returns:
    
    The current description of this object.
  - setNameMap
```
protected void setNameMap(java.util.Map<java.lang.String,java.lang.String> _nameMap)
```
  - getNameMap
```
public java.util.Map<java.lang.String,java.lang.String> getNameMap()
```
  - setDescMap
```
protected void setDescMap(java.util.Map<java.lang.String,java.lang.String> _descMap)
```
  - getDescMap
```
public java.util.Map<java.lang.String,java.lang.String> getDescMap()
```
  - setDeliverySettings
```
public void setDeliverySettings(java.lang.String dlss)
```
  - setTransformationSettings
```
public void setTransformationSettings(java.lang.String tfss)
```
  - getTransmissionType
```
public int getTransmissionType()
```
    Description copied from interface: WebDevice
    
    To get the transmission type of the device
    
    Specified by:
    
    getTransmissionType in interface WebDevice
  - setTransmissionType
```
public void setTransmissionType(int type)
```
    Description copied from interface: WebDevice
    
    To set the transmission type of the device
    
    Specified by:
    
    setTransmissionType in interface WebDevice
    
    Parameters:
    
    type - . Type of transmission, This value comes from EnumDSSXMLSubscriptionDeliveryType
  - IsSupportPlaintextFormat
```
public boolean IsSupportPlaintextFormat()
```
    Description copied from interface: WebDevice
    
    To check if the device support plain text format
    
    Specified by:
    
    IsSupportPlaintextFormat in interface WebDevice
  - setSupportPlaintextFormat
```
public void setSupportPlaintextFormat(boolean flag)
```
    Description copied from interface: WebDevice
    
    To set the device to support plain text format
    
    Specified by:
    
    setSupportPlaintextFormat in interface WebDevice
    
    Parameters:
    
    flag - . True to support, false to not.
  - IsSupportHTMLFormat
```
public boolean IsSupportHTMLFormat()
```
    Description copied from interface: WebDevice
    
    To check if the device support HTML format
    
    Specified by:
    
    IsSupportHTMLFormat in interface WebDevice
  - setSupportHTMLFormat
```
public void setSupportHTMLFormat(boolean flag)
```
    Description copied from interface: WebDevice
    
    To set the device to support HTML format
    
    Specified by:
    
    setSupportHTMLFormat in interface WebDevice
    
    Parameters:
    
    flag - . True to support, false to not.
  - IsSupportHTMLImages
```
public boolean IsSupportHTMLImages()
```
    Description copied from interface: WebDevice
    
    To check if the device support HTML images
    
    Specified by:
    
    IsSupportHTMLImages in interface WebDevice
  - setSupportHTMLImages
```
public void setSupportHTMLImages(boolean flag)
```
    Description copied from interface: WebDevice
    
    To set the device to support HTML images
    
    Specified by:
    
    setSupportHTMLImages in interface WebDevice
    
    Parameters:
    
    flag - . True to support, false to not.
  - IsSupportExcelFormat
```
public boolean IsSupportExcelFormat()
```
    Description copied from interface: WebDevice
    
    To check if the device support excel format
    
    Specified by:
    
    IsSupportExcelFormat in interface WebDevice
  - setSupportExcelFormat
```
public void setSupportExcelFormat(boolean flag)
```
    Description copied from interface: WebDevice
    
    To set the device to support excel format
    
    Specified by:
    
    setSupportExcelFormat in interface WebDevice
    
    Parameters:
    
    flag - . True to support, false to not.
  - IsSupportPDFFormat
```
public boolean IsSupportPDFFormat()
```
    Description copied from interface: WebDevice
    
    To check if the device support PDF format
    
    Specified by:
    
    IsSupportPDFFormat in interface WebDevice
  - setSupportPDFFormat
```
public void setSupportPDFFormat(boolean flag)
```
    Description copied from interface: WebDevice
    
    To set the device support PDF format
    
    Specified by:
    
    setSupportPDFFormat in interface WebDevice
    
    Parameters:
    
    flag - . True to support, false to not.
  - getTransmitter
```
public WebTransmitter getTransmitter()
```
    Description copied from interface: WebDevice
    
    To get the transmitter refered by this device
    
    Specified by:
    
    getTransmitter in interface WebDevice
    
    Returns:
    
    the refered transmitter.
  - setTransmitter
```
public void setTransmitter(java.lang.String transmitterID)
```
  - setTransmitterName
```
public void setTransmitterName(java.lang.String name)
```
  - setTransmitter
```
public void setTransmitter(WebTransmitter transmitter)
```
    Description copied from interface: WebDevice
    
    To set the transmitter refered by this device
    
    Specified by:
    
    setTransmitter in interface WebDevice
    
    Parameters:
    
    transmitter - . An instance of transmitter refered transmitter.
  - generateTransformationSettings
```
protected java.lang.String generateTransformationSettings()
```
  - getXML
```
public java.lang.String getXML()
```
    Description copied from interface: WebObjectInfo
    
    Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.
    
    Specified by:
    
    getXML in interface WebObjectInfo
    
    Returns:
    
    The XML representation of the current state of this object.
  - restoreSettings
```
public void restoreSettings()
```
  - save
```
public void save()
          throws WebObjectsException
```
    Description copied from interface: WebDevice
    
    To save a new/existing device, don't overwrite
    
    Specified by:
    
    save in interface WebDevice
    
    Throws:
    
    WebObjectsException
  - save
```
public void save(boolean overwrite)
          throws WebObjectsException
```
    Description copied from interface: WebDevice
    
    To save a new/existing device
    
    Specified by:
    
    save in interface WebDevice
    
    Throws:
    
    WebObjectsException
  - delete
```
public void delete()
            throws WebObjectsException
```
    Description copied from interface: WebDevice
    
    To delete a existing device.
    
    Specified by:
    
    delete in interface WebDevice
    
    Throws:
    
    WebObjectsException
  - doFlatState
```
protected void doFlatState(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)
```
    Overrides:
    
    doFlatState in class AbstractPersistable
  - getID
```
public java.lang.String getID()
```
    Description copied from interface: WebObjectInfo
    
    Returns the DSS ID of the object, if one exists.
    
    Specified by:
    
    getID in interface WebDisplayUnit
    
    Specified by:
    
    getID in interface WebObjectInfo
    
    Returns:
    
    A String representing the ID of the object.
  - getType
```
public int getType()
```
    Description copied from interface: WebObjectInfo
    
    Returns the type of this object. This will be a value from EnumDSSXMLObjectTypes.
    
    Specified by:
    
    getType in interface WebObjectInfo
    
    Returns:
    
    The type of the object.
  - getSubType
```
public int getSubType()
```
    Description copied from interface: WebObjectInfo
    
    Returns the subtype of the object. This will be a value from EnumDSSXMLObjectSubTypes.
    
    Specified by:
    
    getSubType in interface WebObjectInfo
    
    Returns:
    
    The subtype of the object.
  - getOtherNameTransCount
```
public int getOtherNameTransCount()
```
    Description copied from interface: WebObjectInfo
    
    Returns the count of name translations for locales other than the current effective locale.
    
    Specified by:
    
    getOtherNameTransCount in interface WebObjectInfo
    
    Returns:
    
    The count of name translations for locales other than the current effective locale.
  - getAbbreviation
```
public java.lang.String getAbbreviation()
```
    Description copied from interface: WebObjectInfo
    
    Returns the abbreviation of this object.
    
    Specified by:
    
    getAbbreviation in interface WebObjectInfo
    
    Returns:
    
    The object's abbreviation, if one exists.
  - getVersionID
```
public java.lang.String getVersionID()
```
    Description copied from interface: WebObjectInfo
    
    Returns the Version ID of the object, if one exists.
    
    Specified by:
    
    getVersionID in interface WebObjectInfo
    
    Returns:
    
    A String representing the ID of the object version.
  - getCreationTime
```
public java.lang.String getCreationTime()
```
    Description copied from interface: WebObjectInfo
    
    Returns the creation time of this object, if that information is available.
    
    Specified by:
    
    getCreationTime in interface WebObjectInfo
    
    Returns:
    
    A string representing the creation time of this object.
  - getModificationTime
```
public java.lang.String getModificationTime()
```
    Description copied from interface: WebObjectInfo
    
    Returns the last modification time of the object, if that information is available.
    
    Specified by:
    
    getModificationTime in interface WebObjectInfo
    
    Returns:
    
    A string representing the last modification time of the object.
  - getModificationTimeStamp
```
public long getModificationTimeStamp()
```
    Description copied from interface: WebObjectInfo
    
    Get the object modification timestamp in millisecond.
    
    Specified by:
    
    getModificationTimeStamp in interface WebObjectInfo
  - getCreationTimeStamp
```
public long getCreationTimeStamp()
```
    Description copied from interface: WebObjectInfo
    
    Get the object creation timestamp in millisecond.
    
    Specified by:
    
    getCreationTimeStamp in interface WebObjectInfo
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: WebObjectInfo
    
    Returns whether the object is a hidden object.
    
    Specified by:
    
    isHidden in interface WebObjectInfo
    
    Returns:
    
    True if the object is a hidden object in metadata, false if it is not.
  - setComments
```
public void setComments(java.lang.String[] _comments)
```
    Description copied from interface: WebObjectInfo
    
    Set the long description of the object as an array of strings. The long description is also known as the comments.
    
    Specified by:
    
    setComments in interface WebObjectInfo
    
    Parameters:
    
    _comments - String array of comments
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getComments
```
public java.lang.String[] getComments()
```
    Description copied from interface: WebObjectInfo
    
    Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object. These comments can be set programmatically or using MicroStrategy Desktop (Properties editor -> Long description tab) and are separated by a carriage return.
    
    Specified by:
    
    getComments in interface WebObjectInfo
    
    Returns:
    
    String array of comments
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setHidden
```
public void setHidden(boolean hid)
```
    Description copied from interface: WebObjectInfo
    
    Sets whether the object is a hidden object. To save the change of this property to metadata, EnumDSSXMLObjectFlags.DssXmlObjectBrowser flag need to be set on WebObjectSource before calling WebObjectSource.save(com.microstrategy.web.objects.WebObjectInfo) with this object as input parameter.
    
    Specified by:
    
    setHidden in interface WebObjectInfo
    
    Parameters:
    
    hid - boolean true to set this object to hidden.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getCardStatus
```
public int getCardStatus()
```
    Description copied from interface: WebObjectInfo
    
    Returns the status of the hyper card. This will be a value from EnumDssXmlHyperCardStatus.
    
    Specified by:
    
    getCardStatus in interface WebObjectInfo
    
    Returns:
    
    An int value of the status of the hyper card.
  - getAccessGranted
```
public int getAccessGranted()
```
    Description copied from interface: WebObjectInfo
    
    Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.
    
    Specified by:
    
    getAccessGranted in interface WebObjectInfo
    
    Returns:
    
    The numeric representation of the access this user has to the object.
  - getState
```
public int getState()
```
    Description copied from interface: WebObjectInfo
    
    Returns the state of the object. This value comes from EnumDSSXMLObjectState.
    
    Specified by:
    
    getState in interface WebObjectInfo
    
    Returns:
    
    The state of this object.
  - hasOwner
```
public boolean hasOwner()
```
    Specified by:
    
    hasOwner in interface WebObjectInfo
    
    Returns:
    
    whether there is an owner object available.
  - getOwner
```
public WebObjectInfo getOwner()
                       throws WebObjectsException
```
    Description copied from interface: WebObjectInfo
    
    Returns a WebObjectInfo object which corresponds to the owner of this object.
    
    Specified by:
    
    getOwner in interface WebObjectInfo
    
    Returns:
    
    A WebObjectInfo object, representing the owner of this object
    
    Throws:
    
    WebObjectsException - Thrown if the owner of this object is not available.
  - getPropertySetFilter
```
public SimpleList getPropertySetFilter()
```
    Description copied from interface: WebObjectInfo
    
    Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets
    
    Specified by:
    
    getPropertySetFilter in interface WebObjectInfo
    
    Since:
    
    MicroStrategy Web 8.0.3
  - getPropertySets
```
public WebPropertyGroup getPropertySets()
                                 throws WebObjectsException
```
    Description copied from interface: WebObjectInfo
    
    Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.
    
    Specified by:
    
    getPropertySets in interface WebObjectInfo
    
    Returns:
    
    A WebPropertyGroup object, which contains the property sets associated with this object.
    
    Throws:
    
    WebObjectsException - Thrown if the property sets could not be retrieved.
  - getFlags
```
public int getFlags()
```
    Description copied from interface: WebObjectInfo
    
    Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values from EnumDSSXMLObjectFlags.
    
    Specified by:
    
    getFlags in interface WebObjectInfo
    
    Returns:
    
    The currently set flags value.
    
    See Also:
    
    WebObjectInfo.setFlags(int)
  - setFlags
```
public void setFlags(int _flags)
```
    Description copied from interface: WebObjectInfo
    
    Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.
    
    Specified by:
    
    setFlags in interface WebObjectInfo
    
    Parameters:
    
    _flags - The flags value to use for object definition retrieval.
    
    See Also:
    
    WebObjectInfo.getFlags()
  - getParent
```
public WebFolder getParent()
                    throws java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.
    
    Specified by:
    
    getParent in interface WebObjectInfo
    
    Returns:
    
    The parent folder of the current object. If this is the root folder, then this method will return null.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the parent could not be found or retrieved for the object.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from interface: WebDisplayUnit
    
    Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.
    
    Specified by:
    
    getDisplayName in interface WebDisplayUnit
    
    Returns:
    
    The display name associated with the display unit object.
    
    See Also:
    
    WebDisplayUnit.setDisplayName(java.lang.String), WebObjectInfo.getName()
  - setDisplayName
```
public void setDisplayName(java.lang.String _displayName)
```
    Description copied from interface: WebDisplayUnit
    
    This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.
    
    Specified by:
    
    setDisplayName in interface WebDisplayUnit
    
    Parameters:
    
    _displayName - The display name to associate with the object.
    
    See Also:
    
    WebDisplayUnit.getDisplayName(), WebObjectInfo.getName()
  - getNonSchedulable
```
public boolean getNonSchedulable()
```
    Description copied from interface: WebObjectInfo
    
    Get flag of whether the object is not schedulable
    
    Specified by:
    
    getNonSchedulable in interface WebObjectInfo
    
    Returns:
    
    whether the object is not schedulable
  - setNonSchedulable
```
public void setNonSchedulable(boolean non_schedulable)
```
    Description copied from interface: WebObjectInfo
    
    Set flag of whether the object is not schedulable
    
    Specified by:
    
    setNonSchedulable in interface WebObjectInfo
  - isAncestorNamedFolder
```
public boolean isAncestorNamedFolder(int folderName)
                              throws WebObjectsException,
                                     java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns whether the named folder is this object's ancestor.
    
    Specified by:
    
    isAncestorNamedFolder in interface WebObjectInfo
    
    Parameters:
    
    folderName - An Enumeration in EnumDSSXMLFolderNames
    
    Returns:
    
    true if the named folder in the ancestor list, false otherwise.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in obtaining the DSSID for the named folder.
    
    java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.
  - isFeatureAvailable
```
public boolean isFeatureAvailable(java.lang.String feature)
```
    Description copied from interface: WebFeatures
    
    Returns whether the given feature is available or not.
    
    Specified by:
    
    isFeatureAvailable in interface WebFeatures
    
    Parameters:
    
    feature - The feature to check for, from EnumWebObjectsFeatures.
    
    Returns:
    
    Whether the given feature is available.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isFeatureAvailable
```
public boolean isFeatureAvailable(java.lang.String feature,
                                  java.lang.Object dependencyObject)
```
    Description copied from interface: WebFeatures
    
    Returns whether the given feature is available or not.
    
    Specified by:
    
    isFeatureAvailable in interface WebFeatures
    
    Parameters:
    
    feature - The feature to check for, from EnumWebObjectsFeatures.
    
    dependencyObject - A dependency object which can be used as an additional parameter for certain feature types.
    
    Returns:
    
    Whether the given feature is available.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getXMLForSave
```
protected java.lang.String getXMLForSave()
```
  - getXML
```
public java.lang.String getXML(boolean encode)
```
    Description copied from interface: WebObjectInfo
    
    Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell. The encoding parameter will tell whether the XML generated should have special characters HTML encoded.
    
    Specified by:
    
    getXML in interface WebObjectInfo
    
    Parameters:
    
    encode - If this is true, then the returned string will have all special characters HTML-encoded.
    
    Returns:
    
    The XML representation of the current state of this object.
  - populate
```
public void populate()
              throws WebObjectsException
```
    Description copied from interface: WebObjectInfo
    
    Populates the fields on this object by asking the Intelligence Server for the object definition.
    
    Specified by:
    
    populate in interface WebObjectInfo
    
    Throws:
    
    WebObjectsException - Signals an error while trying to populate this object.
  - getExtParams
```
protected java.lang.String getExtParams()
```
  - performIncrFetchLocally
```
protected boolean performIncrFetchLocally()
```
    Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
    
    Returns:
    
    True if the incremental fetch should be performed on the Web Server Tier otherwise, false.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - populate
```
public void populate(java.lang.String xml)
              throws WebObjectsException
```
    Description copied from interface: WebObjectInfo
    
    Populates the fields on this object by loading the given object definition XML.
    
    Specified by:
    
    populate in interface WebObjectInfo
    
    Parameters:
    
    xml - The XML String to use to populate this object.
    
    Throws:
    
    WebObjectsException - Thrown if the XML string could not be loaded into this object.
  - isPopulated
```
public boolean isPopulated()
```
    Description copied from interface: WebObjectInfo
    
    Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
    
    Specified by:
    
    isPopulated in interface WebObjectInfo
    
    Returns:
    
    The current population status of this object.
  - getAncestors
```
public SimpleList getAncestors()
                        throws java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns a SimpleList containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).
    
    Specified by:
    
    getAncestors in interface WebObjectInfo
    
    Returns:
    
    A SimpleList containing the ancestors of the object.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.
  - getSecurity
```
public WebObjectSecurity getSecurity()
```
    Description copied from interface: WebObjectInfo
    
    Returns the WebObjectSecurity object associated with this WebObjectInfo object. The WebObjectSecurity interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.
    
    Specified by:
    
    getSecurity in interface WebObjectInfo
    
    Returns:
    
    The WebObjectSecurity object associated with this WebObjectInfo object.
    
    Since:
    
    MicroStrategy Web 7.5.2
  - getDisplayUnitType
```
public int getDisplayUnitType()
```
    Description copied from interface: WebDisplayUnit
    
    Returns the type of display unit that this object represents. If this display unit represents a first-class object, then this method will return a value from EnumDSSXMLObjectTypes; otherwise, it will return a value from EnumWebDependentObjectType.
    
    Specified by:
    
    getDisplayUnitType in interface WebDisplayUnit
    
    Returns:
    
    The display unit type, from EnumDSSXMLObjectTypes or EnumWebDependentObjectType.
  - addDetails
```
public void addDetails(boolean details)
                throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.
    
    Specified by:
    
    addDetails in interface WebDisplayUnit
    
    Parameters:
    
    details - The desired state of details for the display unit.
    
    Throws:
    
    WebObjectsException - Thrown if the details cannot be retrieved from the Intelligence Server.
  - getDisplayXML
```
public java.lang.String getDisplayXML()
                               throws WebObjectsException
```
    Throws:
    
    WebObjectsException
  - equals
```
public boolean equals(WebObjectInfo otherOI)
```
  - postProcessOi
```
protected void postProcessOi(com.microstrategy.web.objects.WebObjectInfoImpl obj,
                             SAXSupport parser,
                             AttributesXt attrs)
                      throws org.xml.sax.SAXException
```
    Throws:
    
    org.xml.sax.SAXException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - handleOiBody
```
protected void handleOiBody(SAXSupport parser,
                            java.lang.String local,
                            org.xml.sax.Attributes attrs)
                     throws org.xml.sax.SAXException
```
    Throws:
    
    org.xml.sax.SAXException
  - handleOiEnd
```
protected void handleOiEnd(SAXSupport parser,
                           java.lang.String local,
                           java.lang.String buf)
```
  - isObjectInfo
```
public boolean isObjectInfo()
```
    Description copied from interface: WebDisplayUnit
    
    Returns true if underlying Web Object can be cast to WebObjectInfo. If an object can be cast to WebObjectInfo, then it is a first class object.
    
    Specified by:
    
    isObjectInfo in interface WebDisplayUnit
    
    Returns:
    
    true if underlying Web Object can be cast to WebObjectInfo.
  - buildShortXML
```
public void buildShortXML(WebXMLBuilder builder)
```
    Specified by:
    
    buildShortXML in interface WebObjectInfo
  - buildShortObjectAttributes
```
public void buildShortObjectAttributes(WebXMLBuilder builder)
```
    Specified by:
    
    buildShortObjectAttributes in interface WebObjectInfo
  - equals
```
public boolean equals(java.lang.Object otherObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setAbbreviation
```
public void setAbbreviation(java.lang.String ab)
```
    Specified by:
    
    setAbbreviation in interface WebObjectInfo
    
    Since:
    
    MicroStrategy Web 7.5.2
  - getFactory
```
public WebObjectsFactory getFactory()
```
    Description copied from interface: WebObjectInfo
    
    Returns WebObjectsFactory
    
    Specified by:
    
    getFactory in interface WebObjectInfo
    
    Returns:
    
    WebObjectsFactory
  - checkPrivilege
```
protected boolean checkPrivilege(java.lang.String feature)
                          throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - checkAccessRights
```
protected boolean checkAccessRights(java.lang.String feature)
```
    Since:
    
    MicroStrategy Web 8.0.0
  - checkAccessFlags
```
protected boolean checkAccessFlags(int flags)
```
    Since:
    
    MicroStrategy Web 8.0.0
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: WebObjectInfo
    
    Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.
    
    Specified by:
    
    isDirty in interface WebObjectInfo
    
    Returns:
    
    boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isNew
```
public boolean isNew()
```
    Description copied from interface: WebObjectInfo
    
    Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.
    
    Specified by:
    
    isNew in interface WebObjectInfo
    
    Returns:
    
    boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isBodyDirty
```
protected boolean isBodyDirty()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - createSAXParser
```
protected com.microstrategy.web.objects.WebOISAXParser createSAXParser()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - createDOMHandler
```
protected com.microstrategy.web.objects.WebOIDOMHandler createDOMHandler()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - createDisplayXMLHandler
```
protected com.microstrategy.web.objects.WebOIDisplayXMLHandler createDisplayXMLHandler()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - createXMLBuilder
```
protected com.microstrategy.web.objects.WebOIXMLBuilder createXMLBuilder()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - getPromptInstances
```
public WebPromptInstances getPromptInstances()
```
    Description copied from interface: WebPromptSite
    
    Returns a collection of prompt instances from this prompt site.
    
    Specified by:
    
    getPromptInstances in interface WebPromptSite
    
    Returns:
    
    a collection of prompt instances.
  - isEmbedded
```
public boolean isEmbedded()
```
    Specified by:
    
    isEmbedded in interface WebObjectInfo
  - getContainerType
```
public java.lang.String getContainerType()
```
    Specified by:
    
    getContainerType in interface WebObjectInfo
  - getContainerDid
```
public java.lang.String getContainerDid()
```
    Specified by:
    
    getContainerDid in interface WebObjectInfo
  - setDataSources
```
public void setDataSources(java.lang.String dsXML)
```
    Specified by:
    
    setDataSources in interface WebObjectInfo
  - getDataSources
```
public java.lang.String getDataSources()
```
    Specified by:
    
    getDataSources in interface WebObjectInfo
  - getViewMediaSettings
```
public WebViewMediaSettings getViewMediaSettings()
```
    Specified by:
    
    getViewMediaSettings in interface WebObjectInfo
  - getIconPath
```
public java.lang.String getIconPath()
```
    Description copied from interface: WebObjectInfo
    
    Return the icon path for the object
    
    Specified by:
    
    getIconPath in interface WebObjectInfo
    
    Returns:
    
    String containing the icon path for the object
  - setIconPath
```
public void setIconPath(java.lang.String iconPath)
```
    Description copied from interface: WebObjectInfo
    
    Set the icon path for the object
    
    Specified by:
    
    setIconPath in interface WebObjectInfo
  - setCardStatus
```
public void setCardStatus(int cardStatus)
```
  - getVisualizationViewMode
```
public int getVisualizationViewMode()
```
    Specified by:
    
    getVisualizationViewMode in interface WebObjectInfo
  - getPropertyFlags
```
public int getPropertyFlags()
```
    Description copied from interface: WebObjectInfo
    
    Retrieve the current property flags
    
    Specified by:
    
    getPropertyFlags in interface WebObjectInfo
    
    Returns:
    
    int binary OR of EnumDSSXMLPropertyXmlFlags
  - setPropertyFlags
```
public void setPropertyFlags(int flags)
```
    Description copied from interface: WebObjectInfo
    
    Set the current property flags
    
    Specified by:
    
    setPropertyFlags in interface WebObjectInfo
    
    Parameters:
    
    flags - int binary OR of EnumDSSXMLPropertyXmlFlags
  - setExtendedType
```
public void setExtendedType(int extendedType)
```
    Description copied from interface: WebObjectInfo
    
    Set the current extended type
    
    Specified by:
    
    setExtendedType in interface WebObjectInfo
  - getExtendedType
```
public int getExtendedType()
```
    Description copied from interface: WebObjectInfo
    
    The current extended type
    
    Specified by:
    
    getExtendedType in interface WebObjectInfo
    
    Returns:
    
    the current extended type (a value from EnumDSSXMLExtendedType)
  - getCertifiedInfo
```
public WebCertifiedInfo getCertifiedInfo()
```
    Specified by:
    
    getCertifiedInfo in interface WebObjectInfo
  - setCertifiedInfo
```
public void setCertifiedInfo(WebCertifiedInfo certifiedInfo)
```
  - getTemplateInfo
```
public WebTemplateInfo getTemplateInfo()
```
    Specified by:
    
    getTemplateInfo in interface WebObjectInfo
  - setTemplateInfo
```
public void setTemplateInfo(WebTemplateInfo templateInfo)
```
  - getProjectId
```
public java.lang.String getProjectId()
```
    Specified by:
    
    getProjectId in interface WebObjectInfo
    
    Returns:
    
    project id of the object
  - getDefaultLanguage
```
public java.lang.String getDefaultLanguage()
```
    Specified by:
    
    getDefaultLanguage in interface WebObjectInfo
    
    Returns:
    
    default language of the object
  - setDefaultLanguage
```
public void setDefaultLanguage(java.lang.String defaultLanguage)
```
    Specified by:
    
    setDefaultLanguage in interface WebObjectInfo
  - getProjectName
```
public java.lang.String getProjectName()
```
    Specified by:
    
    getProjectName in interface WebObjectInfo
    
    Returns:
    
    project name of the object
  - getRecommendationInfo
```
public WebRecommendationInfo getRecommendationInfo()
```
    Description copied from interface: WebObjectInfo
    
    This contains all the information related to a recommendation search
    
    Specified by:
    
    getRecommendationInfo in interface WebObjectInfo
    
    Returns:
    
    recommendation info
  - setRecommendationInfo
```
public void setRecommendationInfo(WebRecommendationInfo recommendationInfo)
```
  - setProjectId
```
public void setProjectId(java.lang.String projectId)
```
  - getPreSaveAsFlags
```
public int getPreSaveAsFlags()
```
    Description copied from interface: WebObjectInfo
    
    Returns the flags which determine the previous save as prompt flag. This value is the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.
    
    Specified by:
    
    getPreSaveAsFlags in interface WebObjectInfo
    
    Returns:
    
    The previous set flags value.
    
    See Also:
    
    WebObjectInfo.setPreSaveAsFlags(int)
  - setPreSaveAsFlags
```
public void setPreSaveAsFlags(int flags)
```
    Description copied from interface: WebObjectInfo
    
    Sets the flags which determine the previous save as prompt flag. This value should be the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.
    
    Specified by:
    
    setPreSaveAsFlags in interface WebObjectInfo
    
    Parameters:
    
    flags - The flags value to use for object definition retrieval.
    
    See Also:
    
    WebObjectInfo.getPreSaveAsFlags()
  - isHighlighted
```
public boolean isHighlighted()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this unit is highlighted.
    
    Specified by:
    
    isHighlighted in interface WebDisplayUnit
    
    Returns:
    
    True if the display unit is highlighted, false otherwise.
  - highlightUnit
```
public void highlightUnit()
```
    Description copied from interface: WebDisplayUnit
    
    Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
    
    Specified by:
    
    highlightUnit in interface WebDisplayUnit
  - highlightUnit
```
public void highlightUnit(boolean details)
                   throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    Sets this display unit to be highlighted. The details value will determine whether it should include details as well.
    
    Specified by:
    
    highlightUnit in interface WebDisplayUnit
    
    Parameters:
    
    details - Whether the highlighted unit should include details.
    
    Throws:
    
    WebObjectsException - Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server.
  - isSelected
```
public boolean isSelected()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this display unit is selected.
    
    Specified by:
    
    isSelected in interface WebDisplayUnit
    
    Returns:
    
    True if the unit is selected, false otherwise.
  - setSelected
```
public void setSelected(boolean selected)
```
    Description copied from interface: WebDisplayUnit
    
    Sets the current unit's selection status.
    
    Specified by:
    
    setSelected in interface WebDisplayUnit
    
    Parameters:
    
    selected - Whether the unit should be set to be selected or not.
  - _getObKey
```
public java.lang.Object _getObKey()
```
    Specified by:
    
    _getObKey in interface KeyedObject
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getChildUnits
```
public WebDisplayUnits getChildUnits()
                              throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.
    
    Specified by:
    
    getChildUnits in interface WebDisplayUnit
    
    Returns:
    
    The collection of child display units of this instance, or null if this object is not a collection.
    
    Throws:
    
    WebObjectsException
  - getSelectedCount
```
public int getSelectedCount()
                     throws WebObjectsException
```
    Throws:
    
    WebObjectsException
  - hasDetails
```
public boolean hasDetails()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this display unit currently has details enabled.
    
    Specified by:
    
    hasDetails in interface WebDisplayUnit
    
    Returns:
    
    True if details are enabled, false otherwise.
  - applyVisitor
```
public void applyVisitor(DisplayUnitsVisitor visitor,
                         boolean deep)
                  throws WebObjectsException
```
    Specified by:
    
    applyVisitor in interface WebDisplayUnit
    
    Throws:
    
    WebObjectsException
  - canHighlight
```
public boolean canHighlight()
```
    Specified by:
    
    canHighlight in interface WebDisplayUnit
    
    Since:
    
    MicroStrategy Web 8.0.0
  - saveXMLState
```
protected void saveXMLState(java.lang.StringBuffer buf,
                            int howMuchState)
```
    Overrides:
    
    saveXMLState in class AbstractPersistable
  - saveXMLState
```
protected void saveXMLState(WebXMLBuilder builder,
                            int howMuchState)
```

Class WebFileDeviceImpl

Field Summary

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

Fields inherited from interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags

Fields inherited from interface com.microstrategy.web.objects.EnumWebObjectsFeatures

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.utils.KeyedObject

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

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

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

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

Field Detail

transmitter

deliverySettings

SUPPORTED_FORMAT_TYPES

PROPERTY_SEPERATOR

PROPERTY_VALUE_SEPERATOR

DELIMITER

Constructor Detail

WebFileDeviceImpl

Method Detail

isAppendTimestampToFileName

setAppendTimestampToFileName

isAppendToFile

setAppendToFile

isAppendUserPath

setAppendUserPath

isCreateFolders

setCreateFolders

isOverwriteFiles

setOverwriteFiles

isUseBackUpLocation

setUseBackUpLocation

isFileArchive

setFileArchive

isFileCompress

setFileCompress

isFileEncrypt

setFileEncrypt

isFileIndex

setFileIndex

isFileReadOnly

setFileReadOnly

getLocation

setLocation

getBackUpLocation

setBackUpLocation

getUnixAccessRights

setUnixAccessRights

getDeliveryTimeout

setDeliveryTimeout

getNumberOfRetries

setNumberOfRetries

getTimeBetweenRetries

setTimeBetweenRetries

isEnableUnixToWindows

setEnableUnixToWindows

getPassword

setPassword

getUserName

setUserName

getMountRoot

setMountRoot

getDeviceEncryptionLevel

setDeviceEncryptionLevel

getPreferredEncryptionLevel

setPreferredEncryptionLevel

addProperty

addProperty

addProperty

setName

getName

setDescription

getDescription

setNameMap

getNameMap