java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebFTPDeviceImpl

Summary

Constants
String DELIMITER
String PROPERTY_SEPERATOR
String PROPERTY_VALUE_SEPERATOR
String SUPPORTED_FORMAT_TYPES
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebObjectsFeatures
From interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags
Fields
protected String deliverySettings
protected WebTransmitter transmitter
Public Constructors
WebFTPDeviceImpl(WebObjectsFactory _factory)
Public Methods
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
Object _getObKey()
void addDetails(boolean details)
This method will add or remove details from the display unit.
void applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
void buildShortObjectAttributes(WebXMLBuilder builder)
void buildShortXML(WebXMLBuilder builder)
boolean canHighlight()
void delete()
To delete a existing device.
boolean equals(Object otherObject)
boolean equals(WebObjectInfo otherOI)
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.
WebDisplayUnits getChildUnits()
Returns the collection of child display units, or null if the object is not a collection.
String[] getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
String getContainerDid()
String getContainerType()
String getCreationTime()
Returns the creation time of this object, if that information is available.
String getDataSources()
Map<String, String> getDescMap()
String getDescription()
Returns the description of the object.
int getDeviceEncryptionLevel()
String getDisplayName()
Returns the display name associated with this object.
int getDisplayUnitType()
Returns the type of display unit that this object represents.
String getDisplayXML()
int getExtendedType()
The current extended type
String getFTPServerPassword()
boolean getFTPServerPasswordChanged()
WebObjectsFactory getFactory()
Returns WebObjectsFactory
int getFlags()
Returns the flags which determine what data to populate upon calling populate.
String getID()
Returns the DSS ID of the object, if one exists.
String getIconPath()
Return the icon path for the object
int getMaxConnections()
String getModificationTime()
Returns the last modification time of the object, if that information is available.
long getModificationTimeStamp()
String getName()
Returns the name of this object.
Map<String, String> getNameMap()
boolean getNonSchedulable()
Get flag of whether the object is not schedulable
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.
int getPort()
int getPreferredEncryptionLevel()
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.
String getRemoteDirectory()
WebObjectSecurity getSecurity()
Returns the WebObjectSecurity object associated with this WebObjectInfo object.
int getSelectedCount()
String getServerName()
int getState()
Returns the state of the object.
int getSubType()
Returns the subtype of the object.
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.
String getUserName()
String getVersionID()
Returns the Version ID of the object, if one exists.
WebViewMediaSettings getViewMediaSettings()
int getVisualizationViewMode()
String getXML(boolean encode)
Returns the XML representation of this object.
String getXML()
Returns the XML representation of this object.
boolean hasDetails()
Returns whether this display unit currently has details enabled.
boolean hasOwner()
int hashCode()
void highlightUnit(boolean details)
Sets this display unit to be highlighted.
void highlightUnit()
Sets this display unit to be highlighted.
boolean isASCIIModeFileType()
boolean isAncestorNamedFolder(int folderName)
Returns whether the named folder is this object's ancestor.
boolean isDirty()
Returns whether this object has been modified to be different from the object in metadata.
boolean isEmbedded()
boolean isFeatureAvailable(String feature)
Returns whether the given feature is available or not.
boolean isFeatureAvailable(String feature, Object dependencyObject)
Returns whether the given feature is available or not.
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 isPassiveMode()
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.
void populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.
void populate(String xml)
Populates the fields on this object by loading the given object definition XML.
void restoreSettings()
void save()
To save a new/existing device, don't overwrite
void save(boolean overwrite)
To save a new/existing device
void setASCIIModeFileType(boolean aSCIIModeFileType)
void setAbbreviation(String ab)
void setComments(String[] _comments)
Set the long description of the object as an array of strings.
void setDataSources(String dsXML)
void setDeliverySettings(String dlss)
void setDescription(String _description)
Sets the description of the object.
void setDeviceEncryptionLevel(int deviceEncryptionLevel)
void setDisplayName(String _displayName)
This method will set the value of the display name.
void setExtendedType(int extendedType)
Set the current extended type
void setFTPServerPassword(String fTPServerPassword)
void setFTPServerPasswordChanged(boolean _FTPServerPasswordChanged)
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(String iconPath)
Set the icon path for the object
void setMaxConnections(int maxConnections)
void setName(String _name)
void setNonSchedulable(boolean non_schedulable)
Set flag of whether the object is not schedulable
void setPassiveMode(boolean passiveMode)
void setPort(int port)
void setPreferredEncryptionLevel(int preferredEncryptionLevel)
void setPropertyFlags(int flags)
Set the current property flags
void setRemoteDirectory(String remoteDirectory)
void setSelected(boolean selected)
Sets the current unit's selection status.
void setServerName(String serverName)
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 setTransformationSettings(String tfss)
void setTransmissionType(int type)
To set the transmission type of the device
void setTransmitter(String transmitterID)
void setTransmitter(WebTransmitter transmitter)
To set the transmitter refered by this device
void setTransmitterName(String name)
void setUserName(String userName)
String toString()
Protected Methods
String addProperty(String property, boolean value)
String addProperty(String property, int value)
String addProperty(String property, String value)
boolean checkAccessFlags(int flags)
boolean checkAccessRights(String feature)
boolean checkPrivilege(String feature)
WebOIDOMHandler createDOMHandler()
WebOIDisplayXMLHandler createDisplayXMLHandler()
WebOISAXParser createSAXParser()
WebOIXMLBuilder createXMLBuilder()
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
String generateTransformationSettings()
String getExtParams()
String getXMLForSave()
void handleOiBody(SAXSupport parser, String local, Attributes attrs)
void handleOiEnd(SAXSupport parser, String local, String buf)
boolean isBodyDirty()
boolean performIncrFetchLocally()
Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
void postProcessOi(WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
void setDescMap(Map<String, String> _descMap)
void setNameMap(Map<String, String> _nameMap)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDevice
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Constants

protected static final String DELIMITER

Constant Value: "EndDelimiter***BeginDelimiter++++***"

protected static final String PROPERTY_SEPERATOR

Constant Value: "***"

protected static final String PROPERTY_VALUE_SEPERATOR

Constant Value: "++++"

protected static final String SUPPORTED_FORMAT_TYPES

Constant Value: "FormatTypes"

Fields

protected String deliverySettings

protected WebTransmitter transmitter

Public Constructors

public WebFTPDeviceImpl (WebObjectsFactory _factory)

Public Methods

public boolean IsSupportExcelFormat ()

To check if the device support excel format

public boolean IsSupportHTMLFormat ()

To check if the device support HTML format

public boolean IsSupportHTMLImages ()

To check if the device support HTML images

public boolean IsSupportPDFFormat ()

To check if the device support PDF format

public boolean IsSupportPlaintextFormat ()

To check if the device support plain text format

public Object _getObKey ()

public void addDetails (boolean details)

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.

Parameters
details The desired state of details for the display unit.

public void applyVisitor (DisplayUnitsVisitor visitor, boolean deep)

public void buildShortObjectAttributes (WebXMLBuilder builder)

public void buildShortXML (WebXMLBuilder builder)

public boolean canHighlight ()

public void delete ()

To delete a existing device.

public boolean equals (Object otherObject)

public boolean equals (WebObjectInfo otherOI)

public String getAbbreviation ()

Returns the abbreviation of this object.

Returns
  • The object's abbreviation, if one exists.

public int getAccessGranted ()

Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.

Returns
  • The numeric representation of the access this user has to the object.

public SimpleList getAncestors ()

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).

Returns
  • A SimpleList containing the ancestors of the object.
Throws
UnsupportedOperationException

public WebDisplayUnits getChildUnits ()

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.

Returns
  • The collection of child display units of this instance, or null if this object is not a collection.

public String[] getComments ()

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.

Returns
  • String array of comments

public String getContainerDid ()

public String getContainerType ()

public String getCreationTime ()

Returns the creation time of this object, if that information is available.

Returns
  • A string representing the creation time of this object.

public String getDataSources ()

public Map<String, String> getDescMap ()

public String getDescription ()

Returns the description of the object.

Returns
  • The current description of this object.

public int getDeviceEncryptionLevel ()

public String getDisplayName ()

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.

Returns
  • The display name associated with the display unit object.

public int getDisplayUnitType ()

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.

Returns

public String getDisplayXML ()

public int getExtendedType ()

The current extended type

Returns

public String getFTPServerPassword ()

public boolean getFTPServerPasswordChanged ()

public WebObjectsFactory getFactory ()

Returns WebObjectsFactory

Returns
  • WebObjectsFactory

public int getFlags ()

Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Returns
  • The currently set flags value.

public String getID ()

Returns the DSS ID of the object, if one exists.

Returns
  • A String representing the ID of the object.

public String getIconPath ()

Return the icon path for the object

Returns
  • String containing the icon path for the object

public int getMaxConnections ()

public String getModificationTime ()

Returns the last modification time of the object, if that information is available.

Returns
  • A string representing the last modification time of the object.

public long getModificationTimeStamp ()

public String getName ()

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, setDisplayName(String) should be used along with the 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 getDisplayName() and setDisplayName(String). If you want to change the object's actual metadata name, it can be done via the appropriate save(WebObjectInfo, String) or save(WebObjectInfo, String, WebFolder) calls.

Returns
  • The name of the object.

public Map<String, String> getNameMap ()

public boolean getNonSchedulable ()

Get flag of whether the object is not schedulable

Returns
  • whether the object is not schedulable

public int getOtherNameTransCount ()

Returns the count of name translations for locales other than the current effective locale.

Returns
  • The count of name translations for locales other than the current effective locale.

public WebObjectInfo getOwner ()

Returns a WebObjectInfo object which corresponds to the owner of this object.

Returns
  • A WebObjectInfo object, representing the owner of this object

public WebFolder getParent ()

Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.

Returns
  • The parent folder of the current object. If this is the root folder, then this method will return null.
Throws
UnsupportedOperationException

public int getPort ()

public int getPreferredEncryptionLevel ()

public WebPromptInstances getPromptInstances ()

Returns a collection of prompt instances from this prompt site.

Returns
  • a collection of prompt instances.

public int getPropertyFlags ()

Retrieve the current property flags

Returns

public 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. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets

public WebPropertyGroup getPropertySets ()

Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.

Returns
  • A WebPropertyGroup object, which contains the property sets associated with this object.

public String getRemoteDirectory ()

public WebObjectSecurity getSecurity ()

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.

Returns

public int getSelectedCount ()

public String getServerName ()

public int getState ()

Returns the state of the object. This value comes from EnumDSSXMLObjectState.

Returns
  • The state of this object.

public int getSubType ()

Returns the subtype of the object. This will be a value from EnumDSSXMLObjectSubTypes.

Returns
  • The subtype of the object.

public int getTransmissionType ()

To get the transmission type of the device

public WebTransmitter getTransmitter ()

To get the transmitter refered by this device

Returns
  • the refered transmitter.

public int getType ()

Returns the type of this object. This will be a value from EnumDSSXMLObjectTypes.

Returns
  • The type of the object.

public String getUserName ()

public String getVersionID ()

Returns the Version ID of the object, if one exists.

Returns
  • A String representing the ID of the object version.

public WebViewMediaSettings getViewMediaSettings ()

public int getVisualizationViewMode ()

public String getXML (boolean encode)

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.

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.

public String getXML ()

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.

Returns
  • The XML representation of the current state of this object.

public boolean hasDetails ()

Returns whether this display unit currently has details enabled.

Returns
  • True if details are enabled, false otherwise.

public boolean hasOwner ()

public int hashCode ()

public void highlightUnit (boolean details)

Sets this display unit to be highlighted. The details value will determine whether it should include details as well.

Parameters
details Whether the highlighted unit should include details.

public void highlightUnit ()

Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.

public boolean isASCIIModeFileType ()

public boolean isAncestorNamedFolder (int folderName)

Returns whether the named folder is this object's ancestor.

Parameters
folderName An Enumeration in EnumDSSXMLFolderNames
Returns
  • true if the named folder in the ancestor list, false otherwise.
Throws
WebObjectsException
UnsupportedOperationException

public boolean isDirty ()

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.

Returns
  • boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.

public boolean isEmbedded ()

public boolean isFeatureAvailable (String feature)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
Returns
  • Whether the given feature is available.

public boolean isFeatureAvailable (String feature, Object dependencyObject)

Returns whether the given feature is available or not.

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.

public boolean isHidden ()

Returns whether the object is a hidden object.

Returns
  • True if the object is a hidden object in metadata, false if it is not.

public boolean isHighlighted ()

Returns whether this unit is highlighted.

Returns
  • True if the display unit is highlighted, false otherwise.

public boolean isNew ()

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.

Returns
  • boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.

public boolean isObjectInfo ()

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.

Returns

public boolean isPassiveMode ()

public boolean isPopulated ()

Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.

Returns
  • The current population status of this object.

public boolean isSelected ()

Returns whether this display unit is selected.

Returns
  • True if the unit is selected, false otherwise.

public void populate ()

Populates the fields on this object by asking the Intelligence Server for the object definition.

public void populate (String xml)

Populates the fields on this object by loading the given object definition XML.

Parameters
xml The XML String to use to populate this object.

public void restoreSettings ()

public void save ()

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

public void save (boolean overwrite)

To save a new/existing device

public void setASCIIModeFileType (boolean aSCIIModeFileType)

public void setAbbreviation (String ab)

public void setComments (String[] _comments)

Set the long description of the object as an array of strings. The long description is also known as the comments.

Parameters
_comments String array of comments

public void setDataSources (String dsXML)

public void setDeliverySettings (String dlss)

public void setDescription (String _description)

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.

Parameters
_description The description for the object.

public void setDeviceEncryptionLevel (int deviceEncryptionLevel)

public void setDisplayName (String _displayName)

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.

Parameters
_displayName The display name to associate with the object.

public void setExtendedType (int extendedType)

Set the current extended type

public void setFTPServerPassword (String fTPServerPassword)

public void setFTPServerPasswordChanged (boolean _FTPServerPasswordChanged)

public void setFlags (int _flags)

Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Parameters
_flags The flags value to use for object definition retrieval.

public void setHidden (boolean hid)

Sets whether the object is a hidden object. To save the change of this property to metadata, DssXmlObjectBrowser flag need to be set on WebObjectSource before calling save(WebObjectInfo) with this object as input parameter.

Parameters
hid boolean true to set this object to hidden.

public void setIconPath (String iconPath)

Set the icon path for the object

public void setMaxConnections (int maxConnections)

public void setName (String _name)

public void setNonSchedulable (boolean non_schedulable)

Set flag of whether the object is not schedulable

public void setPassiveMode (boolean passiveMode)

public void setPort (int port)

public void setPreferredEncryptionLevel (int preferredEncryptionLevel)

public void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags

public void setRemoteDirectory (String remoteDirectory)

public void setSelected (boolean selected)

Sets the current unit's selection status.

Parameters
selected Whether the unit should be set to be selected or not.

public void setServerName (String serverName)

public void setSupportExcelFormat (boolean flag)

To set the device to support excel format

public void setSupportHTMLFormat (boolean flag)

To set the device to support HTML format

public void setSupportHTMLImages (boolean flag)

To set the device to support HTML images

public void setSupportPDFFormat (boolean flag)

To set the device support PDF format

public void setSupportPlaintextFormat (boolean flag)

To set the device to support plain text format

public void setTransformationSettings (String tfss)

public void setTransmissionType (int type)

To set the transmission type of the device

public void setTransmitter (String transmitterID)

public void setTransmitter (WebTransmitter transmitter)

To set the transmitter refered by this device

public void setTransmitterName (String name)

public void setUserName (String userName)

public String toString ()

Protected Methods

protected String addProperty (String property, boolean value)

protected String addProperty (String property, int value)

protected String addProperty (String property, String value)

protected boolean checkAccessFlags (int flags)

protected boolean checkAccessRights (String feature)

protected boolean checkPrivilege (String feature)

protected WebOIDOMHandler createDOMHandler ()

protected WebOIDisplayXMLHandler createDisplayXMLHandler ()

protected WebOISAXParser createSAXParser ()

protected WebOIXMLBuilder createXMLBuilder ()

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

protected String generateTransformationSettings ()

protected String getExtParams ()

protected String getXMLForSave ()

protected void handleOiBody (SAXSupport parser, String local, Attributes attrs)

Throws
SAXException

protected void handleOiEnd (SAXSupport parser, String local, String buf)

protected boolean isBodyDirty ()

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.

protected void postProcessOi (WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)

Throws
SAXException

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)

protected void setDescMap (Map<String, String> _descMap)

protected void setNameMap (Map<String, String> _nameMap)