java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebSyncSearchFolder
Known Direct Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebObjectsFeatures
From interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags
[Expand]
Inherited Fields
From class com.microstrategy.utils.serialization.AbstractPersistable
Public Methods
Object _getObKey()
int add(WebObjectInfo newObject)
Adds the given WebObjectInfo object to the folder collection.
int add(WebObjectInfo newObject, int beforeKey)
Adds the given WebObjectInfo object to the folder collection.
int add(WebObjectInfo newObject, WebObjectInfo beforeObject)
Adds the given WebObjectInfo object to the folder collection.
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 checkObjectVisibility(FolderBean fb, boolean isSearch)
Removes from the folder shortcuts whose target is not in the list of requested types.Some extra filtering for search
void checkObjectVisibility(FolderBean fb)
Removes from the folder shortcuts whose target is not in the list of requested types.
void clear()
Clears all objects from the folder collection.
boolean contains(WebObjectInfo object)
Returns true if the folder contains the given object, false if it does not.
boolean containsKey(int key)
Returns true if the folder contains an item by the given key, false if not.
Enumeration elements()
Returns a java.util.Enumeration object, which can be used to iterate through the folder.
boolean equals(Object otherObject)
boolean equals(WebObjectInfo otherOI)
void filterShortcuts(int[] types)
Removes from the folder shortcuts whose target is not in the list of requested types.
WebFolder findTypedObjects(int[] types)
Finds all objects in the folder which are of one of the given types or subtypes, and returns a folder containing those objects.
WebObjectInfo get(int index)
Returns the object in the collection with the given index.
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.
int getBlockBegin()
Returns the current blockBegin setting, which is used for incremental fetch of folder contents.
int getBlockCount()
Returns the current blockCount setting, which is used for incremental fetch of folder contents.
WebCertifiedInfo getCertifiedInfo()
int getChildCount()
Returns the child count, which is the total number of items in the collection.
WebDisplayUnits getChildUnits()
Returns the collection of child display units, or null if the object is not a collection.
Tree<WebObjectInfo> getChildrenInTree()
Returns child units in a tree structure.
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.
long getCreationTimeStamp()
Get the object creation timestamp in millisecond.
String getDataSources()
boolean getDereferenceShorcuts()
Returns whether Shortcut objects are "dereferenced" in folder browsing requests.
String getDescription()
Returns the description of the object.
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
WebObjectsFactory getFactory()
Returns WebObjectsFactory
WebObjectFilter getFilter()
int getFlags()
Returns the flags which determine what data to populate upon calling populate.
int getFolderType()
Returns the type of this folder, a value from EnumDSSXMLFolderType.
String getID()
Returns the DSS ID of the display unit.
String getIconPath()
Return the icon path for the object
boolean getIsBrowsing()
read a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
WebObjectInfo getItemByKey(int key)
Returns the object in the collection with the given key.
String getJsonSearchResult()
int getLevel()
Returns the current value of the level parameter.
String getModificationTime()
Returns the last modification time of the object, if that information is available.
long getModificationTimeStamp()
Get the object modification timestamp in millisecond.
String getName()
Returns the name of this object.
boolean getNonSchedulable()
Get flag of whether the object is not schedulable
int getOriginalChildCount()
In case some types of shortcuts objects will be filtered out from the objectCollection.
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.
boolean getParseDepnObjectDefinitions()
int getPreSaveAsFlags()
Returns the flags which determine the previous save as prompt flag.
String getProjectId()
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.
int getQuickSearchFlag()
WebRecommendationInfo getRecommendationInfo()
This contains all the information related to a recommendation search
WebFolder getRoot()
Returns a folder object representing the root folder of the project.
long getSearchTime()
WebObjectSecurity getSecurity()
Returns the WebObjectSecurity object associated with this WebObjectInfo object.
int getSelectedCount()
int getState()
Returns the state of the object.
int getStyle()
Returns the style in which the display XML of the folder will be output.
int getSubType()
Returns the subtype of the object.
WebSyncSearchResultObj getSyncSearchObj(int index)
int getType()
Returns the type of this object.
SimpleList getTypeRestrictions()
Returns a collection of Integers which represent the set of object types that can be contained in the folder.
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()
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 isDirty()
Returns whether this object has been modified to be different from the object in metadata.
boolean isEmbedded()
boolean isEmpty()
Returns true if the folder object contains nothing, false if it is not empty.
boolean isFeatureAvailable(String feature, Object dependencyObject)
Returns whether the given feature is available or not.
boolean isFeatureAvailable(String feature)
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 isNamedFolder(int folderName)
Returns whether this folder is the named folder.
boolean isNew()
Returns whether this object is newly created at client side, which is not in the metadata.
boolean isNonSchedulable()
boolean isObjectInfo()
Returns true if underlying Web Object can be cast to WebObjectInfo.
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 isReadOnly()
Returns true if this folder is a read-only object, false if it is read/write.
boolean isRoot()
Returns whether this object is the root folder.
boolean isSelected()
Returns whether this display unit is selected.
boolean isSyncSearchResultEmpty()
int keyOf(WebObjectInfo object)
Returns the key of the given object, if it exists in the collection.
SimpleList objectTypes()
Returns a collection of Integers, which contains a non-repeating list of the types of objects which are contained in this folder.
int partialSubFolderCount()
Returns the number of sub-folders in the current folder, within the blockBegin and blockCount constraints.
void populate(String xml)
Populates the fields on this object by loading the given object definition XML.
void populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.
void remove(int index)
Removes the object in the collection with the given index.
void remove(WebObjectInfo object)
Removes the given object from the folder collection.
void removeItemByKey(int key)
Removes the object in the collection with the given key.
void setAbbreviation(String ab)
void setBlockBegin(int _blockBegin)
Sets the blockBegin setting, which is used for incremental fetch of folder contents.
void setBlockCount(int _blockCount)
Sets the blockCount setting, which is used for incremental fetch of folder contents.
void setCertifiedInfo(WebCertifiedInfo certifiedInfo)
void setComments(String[] _comments)
Set the long description of the object as an array of strings.
void setDataSources(String dsXML)
void setDereferenceShortcuts(boolean deref)
Sets whether Shorcuts objects are "dereferenced" in folder browsing requests.
void setDescription(String _description)
Sets the description of the object.
void setDisplayName(String _displayName)
This method will set the value of the display name.
void setExtendedType(int extendedType)
Set the current extended type
void setFilter(WebObjectFilter value)
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 setIsBrowsing(boolean bf)
set a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
void setLevel(int _level)
Sets the value of the level parameter.
void setName(String _name)
void setNonSchedulable(boolean non_schedulable)
Set flag of whether the object is not schedulable
void setNonSchedulableFlag(boolean nonSch)
void setParseDepnObjectDefinitions(boolean parseDef)
void setPreSaveAsFlags(int flags)
Sets the flags which determine the previous save as prompt flag.
void setProjectId(String projectId)
void setPropertyFlags(int flags)
Set the current property flags
void setQuickSearchFlag(int qsr)
Read a QuickSearch flag returned in MetaDataSearch result xml node attribute and set to WebFolder object
void setRecommendationInfo(WebRecommendationInfo recommendationInfo)
void setSearchTime(long searchTime)
void setSelected(boolean selected)
Sets the current unit's selection status.
void setStyle(int style)
Sets the style in which the display XML of the folder will be output.
int size()
Returns the number of objects in the folder.
int subFolderCount()
Returns the number of sub-folders which exist in the current folder, regardless of blockCount.
boolean syncSearchResultContains(WebSyncSearchResultObj object)
Enumeration syncSearchResultElements()
int syncSearchResultSize()
String toString()
Protected Methods
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 getExtParams()
String getXMLForSave()
void handleOiBody(SAXSupport parser, String local, Attributes attrs)
void handleOiEnd(SAXSupport parser, String local, String buf)
boolean isBodyDirty()
boolean isObjectVisible(WebObjectInfo object, FolderBean fb, boolean isSearch)
boolean performIncrFetchLocally()
This method call determines whether we should disregard any incremental fetch options specified on the call, and perform them locally.
void postProcessOi(WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)
void reset()
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
[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.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebFolder
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public Object _getObKey ()

public int add (WebObjectInfo newObject)

Adds the given WebObjectInfo object to the folder collection.

Parameters
newObject An object which implements the WebObjectInfo interface.
Returns
  • The key into the folder of the added object.
Throws
UnsupportedOperationException
IllegalArgumentException

public int add (WebObjectInfo newObject, int beforeKey)

Adds the given WebObjectInfo object to the folder collection.

Parameters
newObject An object which implements the WebObjectInfo interface.
beforeKey The key of an object which this object should be inserted before in the list.
Returns
  • The key into the folder of the added object.
Throws
UnsupportedOperationException
IllegalArgumentException

public int add (WebObjectInfo newObject, WebObjectInfo beforeObject)

Adds the given WebObjectInfo object to the folder collection.

Parameters
newObject An object which implements the WebObjectInfo interface.
beforeObject The object already in the folder to place the new object before.
Returns
  • The key into the folder of the added object.
Throws
UnsupportedOperationException
IllegalArgumentException

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.
Throws
WebObjectsException

public void applyVisitor (DisplayUnitsVisitor visitor, boolean deep)

Throws
WebObjectsException

public void buildShortObjectAttributes (WebXMLBuilder builder)

public void buildShortXML (WebXMLBuilder builder)

public boolean canHighlight ()

public void checkObjectVisibility (FolderBean fb, boolean isSearch)

Removes from the folder shortcuts whose target is not in the list of requested types.Some extra filtering for search

public void checkObjectVisibility (FolderBean fb)

Removes from the folder shortcuts whose target is not in the list of requested types.

public void clear ()

Clears all objects from the folder collection.

Throws
UnsupportedOperationException

public boolean contains (WebObjectInfo object)

Returns true if the folder contains the given object, false if it does not.

Parameters
object The WebObjectInfo object to search for in the folder.
Returns
  • True if the collection contains the value, false if it does not.

public boolean containsKey (int key)

Returns true if the folder contains an item by the given key, false if not.

Parameters
key The key to search for in the folder collection.
Returns
  • True if the collection contains the key, false if it does not.

public Enumeration elements ()

Returns a java.util.Enumeration object, which can be used to iterate through the folder. This Enumeration contains WebObjectInfo objects.

Returns
  • An Enumeration containing all the objects in the folder.

public boolean equals (Object otherObject)

public boolean equals (WebObjectInfo otherOI)

public void filterShortcuts (int[] types)

Removes from the folder shortcuts whose target is not in the list of requested types.

Parameters
types a list of desirable types.

public WebFolder findTypedObjects (int[] types)

Finds all objects in the folder which are of one of the given types or subtypes, and returns a folder containing those objects. NOTE: If the intent is to populate the folder with only a certain set of object types, consider using getTypeRestrictions() before populating.

Parameters
types An array of integers which describe the types or subtypes of objects to return from the folder. The values in the array must be values one of EnumDSSXMLObjectTypes or EnumDSSXMLObjectSubTypes.
Returns
  • A WebFolder that contains all of the objects in the folder which are of one of the types passed in.

public WebObjectInfo get (int index)

Returns the object in the collection with the given index.

Parameters
index The index into the collection of the desired item.
Returns
Throws
IndexOutOfBoundsException

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 int getBlockBegin ()

Returns the current blockBegin setting, which is used for incremental fetch of folder contents. This value tells the index of the first object in the folder to be retrieved. This value is usually used in conjunction with blockCount.

Returns
  • The current blockBegin setting.

public int getBlockCount ()

Returns the current blockCount setting, which is used for incremental fetch of folder contents. This value tells the number of objects in the folder to be retrieved. This value is usually used in conjunction with blockBegin.

Returns
  • The current blockCount setting.

public WebCertifiedInfo getCertifiedInfo ()

public int getChildCount ()

Returns the child count, which is the total number of items in the collection.

Returns
  • The child count of the folder.

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 Tree<WebObjectInfo> getChildrenInTree ()

Returns child units in a tree structure. Currently, when perform a search, and set its setting setGettingTreeInfo(boolean) to true, then the results would bring back data with its browsing tree structure. Only in this case, this method would return the tree. In all other cases, it would return null.

Returns
  • A Tree to represent the search results with its browsing tree structure, or null.

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 long getCreationTimeStamp ()

Get the object creation timestamp in millisecond.

public String getDataSources ()

public boolean getDereferenceShorcuts ()

Returns whether Shortcut objects are "dereferenced" in folder browsing requests. If 'true' then the Shortcut object is replaced with the object it refers to in the folder contents. By default, Shortcut objects are NOT dereferenced.

Returns
  • Whether a Shorcut object is replaced with its target object.

public String getDescription ()

Returns the description of the object.

Returns
  • The current description of this object.

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

Throws
WebObjectsException

public int getExtendedType ()

The current extended type

Returns

public WebObjectsFactory getFactory ()

Returns WebObjectsFactory

Returns
  • WebObjectsFactory

public WebObjectFilter getFilter ()

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 int getFolderType ()

Returns the type of this folder, a value from EnumDSSXMLFolderType.

Returns
  • The type of the current folder, if available.

public String getID ()

Returns the DSS ID of the display unit.

Returns
  • The ID of the display unit.

public String getIconPath ()

Return the icon path for the object

Returns
  • String containing the icon path for the object

public boolean getIsBrowsing ()

read a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects

public WebObjectInfo getItemByKey (int key)

Returns the object in the collection with the given key.

Parameters
key The key into the collection of the desired item.
Returns
Throws
IllegalArgumentException

public String getJsonSearchResult ()

public int getLevel ()

Returns the current value of the level parameter. It is used upon populating the folder's contents. As of MicroStrategy 7.2, this has no effect.

Returns
  • The current level setting.

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

Get the object modification timestamp in millisecond.

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 boolean getNonSchedulable ()

Get flag of whether the object is not schedulable

Returns
  • whether the object is not schedulable

public int getOriginalChildCount ()

In case some types of shortcuts objects will be filtered out from the objectCollection. This function will return the total count received before filtering.

Returns
  • The original child count of the folder.

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
Throws
WebObjectsException

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 boolean getParseDepnObjectDefinitions ()

public int getPreSaveAsFlags ()

Returns the flags which determine the previous save as prompt flag. This value is the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.

Returns
  • The previous set flags value.

public String getProjectId ()

public String getProjectName ()

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.
Throws
WebObjectsException

public int getQuickSearchFlag ()

public WebRecommendationInfo getRecommendationInfo ()

This contains all the information related to a recommendation search

Returns
  • recommendation info

public WebFolder getRoot ()

Returns a folder object representing the root folder of the project.

Returns
  • A populated WebFolder object, representing the root folder of the hierarchy.
Throws
WebObjectsException

public long getSearchTime ()

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

Throws
WebObjectsException

public int getState ()

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

Returns
  • The state of this object.

public int getStyle ()

Returns the style in which the display XML of the folder will be output.

Returns

public int getSubType ()

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

Returns
  • The subtype of the object.

public WebSyncSearchResultObj getSyncSearchObj (int index)

Throws
IndexOutOfBoundsException

public int getType ()

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

Returns
  • The type of the object.

public SimpleList getTypeRestrictions ()

Returns a collection of Integers which represent the set of object types that can be contained in the folder. This collection is modified by the caller to specify a set of "type restrictions". If no types are added, then there are no restrictions.

Returns
  • A SimpleList containing the types of objects that can be included in the contents of the folder when it is populated by the Intelligence Server.

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

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

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.
Throws
WebObjectsException

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 isEmpty ()

Returns true if the folder object contains nothing, false if it is not empty.

Returns
  • Whether the folder is empty.

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 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 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 isNamedFolder (int folderName)

Returns whether this folder is the named folder. Note that if the named folder ID cannot be determined(because of an error from the Intelligence Server), this method will return false and log a warning.

Parameters
folderName An Enumeration in EnumDSSXMLFolderNames
Returns
  • true if this folder the named folder, 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 isNonSchedulable ()

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 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 isReadOnly ()

Returns true if this folder is a read-only object, false if it is read/write.

Returns
  • The read-only status of this folder.

public boolean isRoot ()

Returns whether this object is the root folder. Note that if the ancestor information is not available for this object, or if this object is the root folder, a call to the Intelligence Server will be necessary.

Returns
  • True if this object is the root folder, false otherwise.
Throws
WebObjectsException

public boolean isSelected ()

Returns whether this display unit is selected.

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

public boolean isSyncSearchResultEmpty ()

public int keyOf (WebObjectInfo object)

Returns the key of the given object, if it exists in the collection.

Parameters
object The WebObjectInfo object to search for in the folder.
Returns
  • The key of the object.
Throws
IllegalArgumentException

public SimpleList objectTypes ()

Returns a collection of Integers, which contains a non-repeating list of the types of objects which are contained in this folder. The object types come from EnumDSSXMLObjectTypes.

Returns
  • A SimpleList, containing the types of objects contained in the folder.

public int partialSubFolderCount ()

Returns the number of sub-folders in the current folder, within the blockBegin and blockCount constraints.

Returns
  • A count of the sub-folders of the current folder.

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.
Throws
WebObjectsException

public void populate ()

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

Throws
WebObjectsException

public void remove (int index)

Removes the object in the collection with the given index.

Parameters
index The index of the item to be removed.
Throws
UnsupportedOperationException
IndexOutOfBoundsException

public void remove (WebObjectInfo object)

Removes the given object from the folder collection. Returns true if the operation succeeded.

Parameters
object The object to be removed from the collection.
Throws
UnsupportedOperationException
IllegalArgumentException

public void removeItemByKey (int key)

Removes the object in the collection with the given key.

Parameters
key The key into the collection of the item to be removed.
Throws
UnsupportedOperationException
IllegalArgumentException

public void setAbbreviation (String ab)

public void setBlockBegin (int _blockBegin)

Sets the blockBegin setting, which is used for incremental fetch of folder contents. This value tells the index of the first object in the folder to be retrieved. This value is usually used in conjunction with blockCount.

Parameters
_blockBegin The blockBegin setting to be used upon populating the folder from the Intelligence Server.

public void setBlockCount (int _blockCount)

Sets the blockCount setting, which is used for incremental fetch of folder contents. This value tells the number of objects in the folder to be retrieved. This value is usually used in conjunction with blockBegin.

Parameters
_blockCount The blockCount setting to be used upon populating the folder from the Intelligence Server.

public void setCertifiedInfo (WebCertifiedInfo certifiedInfo)

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 setDereferenceShortcuts (boolean deref)

Sets whether Shorcuts objects are "dereferenced" in folder browsing requests. If 'true' then the Shorcut object is replaced with the object it refers to in the folder contents.

Parameters
deref Whether to dereference shortcut objects or not.

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 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 setFilter (WebObjectFilter value)

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 setIsBrowsing (boolean bf)

set a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects

public void setLevel (int _level)

Sets the value of the level parameter. It is used upon populating the folder's contents. As of MicroStrategy 7.2, this has no effect.

Parameters
_level The new level setting.

public void setName (String _name)

public void setNonSchedulable (boolean non_schedulable)

Set flag of whether the object is not schedulable

public void setNonSchedulableFlag (boolean nonSch)

public void setParseDepnObjectDefinitions (boolean parseDef)

public void setPreSaveAsFlags (int flags)

Sets the flags which determine the previous save as prompt flag. This value should be the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.

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

public void setProjectId (String projectId)

public void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags

public void setQuickSearchFlag (int qsr)

Read a QuickSearch flag returned in MetaDataSearch result xml node attribute and set to WebFolder object

public void setRecommendationInfo (WebRecommendationInfo recommendationInfo)

public void setSearchTime (long searchTime)

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 setStyle (int style)

Sets the style in which the display XML of the folder will be output.

Parameters
style The display style to use for the folder, which should be a value from EnumWebFolderDisplayStyle.

public int size ()

Returns the number of objects in the folder.

Returns
  • The number of objects in the folder collection.

public int subFolderCount ()

Returns the number of sub-folders which exist in the current folder, regardless of blockCount.

Returns
  • A count of the sub-folders of the current folder.

public boolean syncSearchResultContains (WebSyncSearchResultObj object)

public Enumeration syncSearchResultElements ()

public int syncSearchResultSize ()

public String toString ()

Protected Methods

protected boolean checkAccessFlags (int flags)

protected boolean checkAccessRights (String feature)

protected boolean checkPrivilege (String feature)

Throws
WebObjectsException

protected WebOIDOMHandler createDOMHandler ()

protected WebOIDisplayXMLHandler createDisplayXMLHandler ()

protected WebOISAXParser createSAXParser ()

protected WebOIXMLBuilder createXMLBuilder ()

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

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 isObjectVisible (WebObjectInfo object, FolderBean fb, boolean isSearch)

protected boolean performIncrFetchLocally ()

This method call determines whether we should disregard any incremental fetch options specified on the call, and perform them locally. This method returns true if there are a set of type restrictions applied to the folder contents. If true, then we will fetch ALL elements of the folder from the IServer and "chunk" the results as per the specified type restrictions and incremental fetch settings.

Returns
  • True, if we should perform the incremental fetch locally; otherwise, false.

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

Throws
SAXException

protected void reset ()

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)