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

All Implemented Interfaces:

KeyedObject, EnumWebPersistableState, Persistable, EnumWebObjectsFeatures, WebDisplayUnit, WebFeatures, WebFolder, WebObjectInfo, WebPromptSite, EnumDSSXMLAccessRightFlags

Direct Known Subclasses:

WebSyncRecommendationFolder
```
public class WebSyncSearchFolder
extends AbstractPersistable
```

Field Summary
- 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.web.objects.EnumWebObjectsFeatures
  FolderFeatureAddChild, FolderFeatureRemoveChild, ObjectFeatureBrowse, ObjectFeatureCopy, ObjectFeatureCreateShortcut, ObjectFeatureDelete, ObjectFeatureMove, ObjectFeatureUpdate, WebObjectsSubscriptionBulkExport, WebObjectsSubscriptionCustMsg, WebObjectsSubscriptionDeliveryEmail, WebObjectsSubscriptionDeliveryFile, WebObjectsSubscriptionDeliveryFtp, WebObjectsSubscriptionDeliveryPrint, WebObjectsSubscriptionHTMLDocument, WebObjectsSubscriptionNotification, WebObjectsSubscriptionRWDocument, WebObjectsSubscriptionSendNowEmail
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.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()`
`protected boolean`	`checkAccessFlags(int flags)`
`protected boolean`	`checkAccessRights(java.lang.String feature)`
`void`	`checkObjectVisibility(FolderBean fb)`	Removes from the folder shortcuts whose target is not in the list of requested types.
`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
`protected boolean`	`checkPrivilege(java.lang.String feature)`
`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.
`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()`
`protected void`	`doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)`
`java.util.Enumeration`	`elements()`	Returns a java.util.Enumeration object, which can be used to iterate through the folder.
`boolean`	`equals(WebObjectInfo otherOI)`
`boolean`	`equals(java.lang.Object otherObject)`
`void`	`filterDossierObjects()`	remove the Dossier objects from the list of objects in the folder.
`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.
`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.
`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.
`int`	`getCardStatus()`	Returns the status of the hyper card.
`WebCertifiedInfo`	`getCertifiedInfo()`
`int`	`getChildCount()`	Returns the child count, which is the total number of items in the collection.
`Tree<WebObjectInfo>`	`getChildrenInTree()`	Returns child units in a tree structure.
`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()`
`boolean`	`getDereferenceShorcuts()`	Returns whether Shortcut objects are "dereferenced" in folder browsing requests.
`java.lang.String`	`getDescription()`	Returns the description of the object.
`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
`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`.
`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.
`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.
`java.lang.String`	`getJsonSearchResult()`
`int`	`getLevel()`	Returns the current value of the level parameter.
`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`	`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.
`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.
`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)`
`WebTemplateInfo`	`getTemplateInfo()`
`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.
`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.
`protected boolean`	`isBodyDirty()`
`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(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`	`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`.
`protected boolean`	`isObjectVisible(WebObjectInfo object, FolderBean fb, boolean isSearch)`
`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.
`protected boolean`	`performIncrFetchLocally()`	This method call determines whether we should disregard any incremental fetch options specified on the call, and perform them locally.
`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`	`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.
`protected void`	`reset()`
`protected void`	`saveXMLState(WebXMLBuilder builder, int howMuchState)`
`protected void`	`saveXMLState(java.lang.StringBuffer buf, int howMuchState)`
`void`	`setAbbreviation(java.lang.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`	`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`	`setDataSources(java.lang.String dsXML)`
`void`	`setDefaultLanguage(java.lang.String defaultLanguage)`
`void`	`setDereferenceShortcuts(boolean deref)`	Sets whether Shorcuts objects are "dereferenced" in folder browsing requests.
`void`	`setDescription(java.lang.String _description)`	Sets the description of the object.
`void`	`setDisplayName(java.lang.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(java.lang.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(java.lang.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(java.lang.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.
`void`	`setTemplateInfo(WebTemplateInfo templateInfo)`
`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)`
`java.util.Enumeration`	`syncSearchResultElements()`
`int`	`syncSearchResultSize()`
`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
applyVisitor, canHighlight, 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, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDefaultLanguage, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getTemplateInfo, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, setAbbreviation, setComments, setDefaultLanguage, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

- Method Detail
  - createSAXParser
```
protected com.microstrategy.web.objects.WebOISAXParser createSAXParser()
```
  - getSearchTime
```
public long getSearchTime()
```
  - setSearchTime
```
public void setSearchTime(long searchTime)
```
  - getJsonSearchResult
```
public java.lang.String getJsonSearchResult()
```
  - reset
```
protected void reset()
```
  - 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.
  - getSyncSearchObj
```
public WebSyncSearchResultObj getSyncSearchObj(int index)
                                        throws java.lang.IndexOutOfBoundsException
```
    Throws:
    
    java.lang.IndexOutOfBoundsException
  - isSyncSearchResultEmpty
```
public boolean isSyncSearchResultEmpty()
```
  - syncSearchResultSize
```
public int syncSearchResultSize()
```
  - syncSearchResultContains
```
public boolean syncSearchResultContains(WebSyncSearchResultObj object)
```
  - syncSearchResultElements
```
public java.util.Enumeration syncSearchResultElements()
```
  - buildShortXML
```
public void buildShortXML(WebXMLBuilder builder)
```
    Specified by:
    
    buildShortXML in interface WebObjectInfo
  - getDereferenceShorcuts
```
public boolean getDereferenceShorcuts()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    getDereferenceShorcuts in interface WebFolder
    
    Returns:
    
    Whether a Shorcut object is replaced with its target object.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - setDereferenceShortcuts
```
public void setDereferenceShortcuts(boolean deref)
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    setDereferenceShortcuts in interface WebFolder
    
    Parameters:
    
    deref - Whether to dereference shortcut objects or not.
    
    Since:
    
    MicroStrategy Web 8.0.1
  - setParseDepnObjectDefinitions
```
public void setParseDepnObjectDefinitions(boolean parseDef)
```
  - getParseDepnObjectDefinitions
```
public boolean getParseDepnObjectDefinitions()
```
  - 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.
  - getFolderType
```
public int getFolderType()
```
    Description copied from interface: WebFolder
    
    Returns the type of this folder, a value from EnumDSSXMLFolderType.
    
    Specified by:
    
    getFolderType in interface WebFolder
    
    Returns:
    
    The type of the current folder, if available.
  - getRoot
```
public WebFolder getRoot()
                  throws WebObjectsException
```
    Description copied from interface: WebFolder
    
    Returns a folder object representing the root folder of the project.
    
    Specified by:
    
    getRoot in interface WebFolder
    
    Returns:
    
    A populated WebFolder object, representing the root folder of the hierarchy.
    
    Throws:
    
    WebObjectsException - Signals an error while trying to obtain the root folder.
  - subFolderCount
```
public int subFolderCount()
```
    Description copied from interface: WebFolder
    
    Returns the number of sub-folders which exist in the current folder, regardless of blockCount.
    
    Specified by:
    
    subFolderCount in interface WebFolder
    
    Returns:
    
    A count of the sub-folders of the current folder.
  - partialSubFolderCount
```
public int partialSubFolderCount()
```
    Description copied from interface: WebFolder
    
    Returns the number of sub-folders in the current folder, within the blockBegin and blockCount constraints.
    
    Specified by:
    
    partialSubFolderCount in interface WebFolder
    
    Returns:
    
    A count of the sub-folders of the current folder.
  - findTypedObjects
```
public WebFolder findTypedObjects(int[] types)
```
    Description copied from interface: WebFolder
    
    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 WebFolder.getTypeRestrictions() before populating.
    
    Specified by:
    
    findTypedObjects in interface WebFolder
    
    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.
  - objectTypes
```
public SimpleList objectTypes()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    objectTypes in interface WebFolder
    
    Returns:
    
    A SimpleList, containing the types of objects contained in the folder.
  - getBlockBegin
```
public int getBlockBegin()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    getBlockBegin in interface WebFolder
    
    Returns:
    
    The current blockBegin setting.
    
    See Also:
    
    WebFolder.setBlockBegin(int)
  - setBlockBegin
```
public void setBlockBegin(int _blockBegin)
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    setBlockBegin in interface WebFolder
    
    Parameters:
    
    _blockBegin - The blockBegin setting to be used upon populating the folder from the Intelligence Server.
    
    See Also:
    
    WebFolder.getBlockBegin()
  - getBlockCount
```
public int getBlockCount()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    getBlockCount in interface WebFolder
    
    Returns:
    
    The current blockCount setting.
    
    See Also:
    
    WebFolder.setBlockCount(int)
  - setBlockCount
```
public void setBlockCount(int _blockCount)
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    setBlockCount in interface WebFolder
    
    Parameters:
    
    _blockCount - The blockCount setting to be used upon populating the folder from the Intelligence Server.
    
    See Also:
    
    WebFolder.getBlockCount()
  - getQuickSearchFlag
```
public int getQuickSearchFlag()
```
    Specified by:
    
    getQuickSearchFlag in interface WebFolder
    
    Returns:
    
    Integer flag value either 0 or 1
  - setQuickSearchFlag
```
public void setQuickSearchFlag(int qsr)
```
    Description copied from interface: WebFolder
    
    Read a QuickSearch flag returned in MetaDataSearch result xml node attribute and set to WebFolder object
    
    Specified by:
    
    setQuickSearchFlag in interface WebFolder
  - getIsBrowsing
```
public boolean getIsBrowsing()
```
    Description copied from interface: WebFolder
    
    read a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
    
    Specified by:
    
    getIsBrowsing in interface WebFolder
    
    Returns:
  - setIsBrowsing
```
public void setIsBrowsing(boolean bf)
```
    Description copied from interface: WebFolder
    
    set a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
    
    Specified by:
    
    setIsBrowsing in interface WebFolder
  - getExtParams
```
protected java.lang.String getExtParams()
```
  - isNonSchedulable
```
public boolean isNonSchedulable()
```
    Specified by:
    
    isNonSchedulable in interface WebFolder
    
    Returns:
    
    boolean flag indicates the trigger folder is Non-Schedulable.
  - setNonSchedulableFlag
```
public void setNonSchedulableFlag(boolean nonSch)
```
  - getTypeRestrictions
```
public SimpleList getTypeRestrictions()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    getTypeRestrictions in interface WebFolder
    
    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.
    
    Since:
    
    MicroStrategy Web 8.0.2
    
    See Also:
    
    WebFolder.setDereferenceShortcuts(boolean)
  - getLevel
```
public int getLevel()
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    getLevel in interface WebFolder
    
    Returns:
    
    The current level setting.
    
    See Also:
    
    WebFolder.setLevel(int)
  - setLevel
```
public void setLevel(int _level)
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    setLevel in interface WebFolder
    
    Parameters:
    
    _level - The new level setting.
    
    See Also:
    
    WebFolder.getLevel()
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: WebFolder
    
    Returns true if this folder is a read-only object, false if it is read/write.
    
    Specified by:
    
    isReadOnly in interface WebFolder
    
    Returns:
    
    The read-only status of this folder.
  - add
```
public int add(WebObjectInfo newObject)
        throws java.lang.UnsupportedOperationException,
               java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Adds the given WebObjectInfo object to the folder collection.
    
    Specified by:
    
    add in interface WebFolder
    
    Parameters:
    
    newObject - An object which implements the WebObjectInfo interface.
    
    Returns:
    
    The key into the folder of the added object.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is marked as read-only.
    
    java.lang.IllegalArgumentException - Thrown if there is an error when adding the object to the collection.
  - add
```
public int add(WebObjectInfo newObject,
               int beforeKey)
        throws java.lang.UnsupportedOperationException,
               java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Adds the given WebObjectInfo object to the folder collection.
    
    Specified by:
    
    add in interface WebFolder
    
    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:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is marked as read-only
    
    java.lang.IllegalArgumentException - Thrown if there is an error when adding the object to the collection, for example, if the key given does not exist..
  - add
```
public int add(WebObjectInfo newObject,
               WebObjectInfo beforeObject)
        throws java.lang.UnsupportedOperationException,
               java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Adds the given WebObjectInfo object to the folder collection.
    
    Specified by:
    
    add in interface WebFolder
    
    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:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is marked as read-only
    
    java.lang.IllegalArgumentException - Thrown if there is an error when adding the object to the collection, for example, if the beforeObject given does not exist..
  - get
```
public WebObjectInfo get(int index)
                  throws java.lang.IndexOutOfBoundsException
```
    Description copied from interface: WebFolder
    
    Returns the object in the collection with the given index.
    
    Specified by:
    
    get in interface WebFolder
    
    Parameters:
    
    index - The index into the collection of the desired item.
    
    Returns:
    
    The WebObjectInfo object with the given index in the collection.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.
  - getItemByKey
```
public WebObjectInfo getItemByKey(int key)
                           throws java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Returns the object in the collection with the given key.
    
    Specified by:
    
    getItemByKey in interface WebFolder
    
    Parameters:
    
    key - The key into the collection of the desired item.
    
    Returns:
    
    The WebObjectInfo object with the given key in the collection.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if the given key is not found in the collection.
  - remove
```
public void remove(int index)
            throws java.lang.UnsupportedOperationException,
                   java.lang.IndexOutOfBoundsException
```
    Description copied from interface: WebFolder
    
    Removes the object in the collection with the given index.
    
    Specified by:
    
    remove in interface WebFolder
    
    Parameters:
    
    index - The index of the item to be removed.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is read-only.
    
    java.lang.IndexOutOfBoundsException - Thrown if the given index is out of the bounds of the collection.
  - removeItemByKey
```
public void removeItemByKey(int key)
                     throws java.lang.UnsupportedOperationException,
                            java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Removes the object in the collection with the given key.
    
    Specified by:
    
    removeItemByKey in interface WebFolder
    
    Parameters:
    
    key - The key into the collection of the item to be removed.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is read-only.
    
    java.lang.IllegalArgumentException - Thrown if the given key is not found in the collection.
  - remove
```
public void remove(WebObjectInfo object)
            throws java.lang.UnsupportedOperationException,
                   java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Removes the given object from the folder collection. Returns true if the operation succeeded.
    
    Specified by:
    
    remove in interface WebFolder
    
    Parameters:
    
    object - The object to be removed from the collection.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is read-only.
    
    java.lang.IllegalArgumentException - Thrown if the given object is not found in the collection.
  - clear
```
public void clear()
           throws java.lang.UnsupportedOperationException
```
    Description copied from interface: WebFolder
    
    Clears all objects from the folder collection.
    
    Specified by:
    
    clear in interface WebFolder
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the folder object is marked as read-only.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: WebFolder
    
    Returns true if the folder object contains nothing, false if it is not empty.
    
    Specified by:
    
    isEmpty in interface WebFolder
    
    Returns:
    
    Whether the folder is empty.
  - size
```
public int size()
```
    Description copied from interface: WebFolder
    
    Returns the number of objects in the folder.
    
    Specified by:
    
    size in interface WebFolder
    
    Returns:
    
    The number of objects in the folder collection.
  - containsKey
```
public boolean containsKey(int key)
```
    Description copied from interface: WebFolder
    
    Returns true if the folder contains an item by the given key, false if not.
    
    Specified by:
    
    containsKey in interface WebFolder
    
    Parameters:
    
    key - The key to search for in the folder collection.
    
    Returns:
    
    True if the collection contains the key, false if it does not.
  - contains
```
public boolean contains(WebObjectInfo object)
```
    Description copied from interface: WebFolder
    
    Returns true if the folder contains the given object, false if it does not.
    
    Specified by:
    
    contains in interface WebFolder
    
    Parameters:
    
    object - The WebObjectInfo object to search for in the folder.
    
    Returns:
    
    True if the collection contains the value, false if it does not.
  - keyOf
```
public int keyOf(WebObjectInfo object)
          throws java.lang.IllegalArgumentException
```
    Description copied from interface: WebFolder
    
    Returns the key of the given object, if it exists in the collection.
    
    Specified by:
    
    keyOf in interface WebFolder
    
    Parameters:
    
    object - The WebObjectInfo object to search for in the folder.
    
    Returns:
    
    The key of the object.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if the object does not exist in the collection.
  - elements
```
public java.util.Enumeration elements()
```
    Description copied from interface: WebFolder
    
    Returns a java.util.Enumeration object, which can be used to iterate through the folder. This Enumeration contains WebObjectInfo objects.
    
    Specified by:
    
    elements in interface WebFolder
    
    Returns:
    
    An Enumeration containing all the objects in the folder.
  - 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.
  - setStyle
```
public void setStyle(int style)
```
    Description copied from interface: WebFolder
    
    Sets the style in which the display XML of the folder will be output.
    
    Specified by:
    
    setStyle in interface WebFolder
    
    Parameters:
    
    style - The display style to use for the folder, which should be a value from EnumWebFolderDisplayStyle.
    
    See Also:
    
    WebFolder.getStyle()
  - 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.
  - getStyle
```
public int getStyle()
```
    Description copied from interface: WebFolder
    
    Returns the style in which the display XML of the folder will be output.
    
    Specified by:
    
    getStyle in interface WebFolder
    
    Returns:
    
    The current display style of the folder, from EnumWebFolderDisplayStyle.
    
    See Also:
    
    WebFolder.setStyle(int)
  - isRoot
```
public boolean isRoot()
               throws WebObjectsException
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    isRoot in interface WebFolder
    
    Returns:
    
    True if this object is the root folder, false otherwise.
    
    Throws:
    
    WebObjectsException - Signals an inability to contact the Intelligence Server or to retrieve whether this is the root folder.
  - isNamedFolder
```
public boolean isNamedFolder(int folderName)
```
    Description copied from interface: WebFolder
    
    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.
    
    Specified by:
    
    isNamedFolder in interface WebFolder
    
    Parameters:
    
    folderName - An Enumeration in EnumDSSXMLFolderNames
    
    Returns:
    
    true if this folder the named folder, false otherwise.
  - getChildUnits
```
public WebDisplayUnits getChildUnits()
```
    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.
  - getChildrenInTree
```
public Tree<WebObjectInfo> getChildrenInTree()
```
    Description copied from interface: WebFolder
    
    Returns child units in a tree structure. Currently, when perform a search, and set its setting WebSearch.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.
    
    Specified by:
    
    getChildrenInTree in interface WebFolder
    
    Returns:
    
    A Tree to represent the search results with its browsing tree structure, or null.
  - getChildCount
```
public int getChildCount()
```
    Description copied from interface: WebFolder
    
    Returns the child count, which is the total number of items in the collection.
    
    Specified by:
    
    getChildCount in interface WebFolder
    
    Returns:
    
    The child count of the folder.
  - getOriginalChildCount
```
public int getOriginalChildCount()
```
    Description copied from interface: WebFolder
    
    In case some types of shortcuts objects will be filtered out from the objectCollection. This function will return the total count received before filtering.
    
    Specified by:
    
    getOriginalChildCount in interface WebFolder
    
    Returns:
    
    The original child count of the folder.
  - checkAccessRights
```
protected boolean checkAccessRights(java.lang.String feature)
```
    Since:
    
    MicroStrategy Web 8.0.0
  - performIncrFetchLocally
```
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.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - setDataSources
```
public void setDataSources(java.lang.String dsXML)
```
    Specified by:
    
    setDataSources in interface WebObjectInfo
  - setFilter
```
public void setFilter(WebObjectFilter value)
```
    Specified by:
    
    setFilter in interface WebFolder
  - getFilter
```
public WebObjectFilter getFilter()
```
    Specified by:
    
    getFilter in interface WebFolder
  - filterDossierObjects
```
public void filterDossierObjects()
```
    remove the Dossier objects from the list of objects in the folder.
    
    Specified by:
    
    filterDossierObjects in interface WebFolder
  - filterShortcuts
```
public void filterShortcuts(int[] types)
```
    Description copied from interface: WebFolder
    
    Removes from the folder shortcuts whose target is not in the list of requested types.
    
    Specified by:
    
    filterShortcuts in interface WebFolder
    
    Parameters:
    
    types - a list of desirable types.
  - isObjectVisible
```
protected boolean isObjectVisible(WebObjectInfo object,
                                  FolderBean fb,
                                  boolean isSearch)
```
  - checkObjectVisibility
```
public void checkObjectVisibility(FolderBean fb)
```
    Description copied from interface: WebFolder
    
    Removes from the folder shortcuts whose target is not in the list of requested types.
    
    Specified by:
    
    checkObjectVisibility in interface WebFolder
  - checkObjectVisibility
```
public void checkObjectVisibility(FolderBean fb,
                                  boolean isSearch)
```
    Description copied from interface: WebFolder
    
    Removes from the folder shortcuts whose target is not in the list of requested types.Some extra filtering for search
    
    Specified by:
    
    checkObjectVisibility in interface WebFolder
  - 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.
  - 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.
  - setName
```
public void setName(java.lang.String _name)
```
    Specified by:
    
    setName in interface WebObjectInfo
  - 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.
  - 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.
  - 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.
  - 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.
    
    Since:
    
    MicroStrategy Web 7.5.2
  - 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()
  - 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()
```
    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.
  - 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.
  - 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.
  - 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.
  - 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
  - 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
  - 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
  - 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
  - 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 WebSyncSearchFolder

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

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

Method Detail

createSAXParser

getSearchTime

setSearchTime

getJsonSearchResult

reset

populate

getSyncSearchObj

isSyncSearchResultEmpty

syncSearchResultSize

syncSearchResultContains

syncSearchResultElements

buildShortXML

getDereferenceShorcuts

setDereferenceShortcuts

setParseDepnObjectDefinitions

getParseDepnObjectDefinitions

getParent

getFolderType

getRoot

subFolderCount

partialSubFolderCount

findTypedObjects

objectTypes

getBlockBegin

setBlockBegin

getBlockCount

setBlockCount

getQuickSearchFlag

setQuickSearchFlag

getIsBrowsing

setIsBrowsing

getExtParams

isNonSchedulable

setNonSchedulableFlag

getTypeRestrictions

getLevel

setLevel

isReadOnly

add

add

add

get

getItemByKey

remove

removeItemByKey

remove

clear

isEmpty

size

containsKey

contains

keyOf

elements

populate

setStyle

addDetails

getStyle

isRoot

isNamedFolder

getChildUnits

getChildrenInTree

getChildCount

getOriginalChildCount

checkAccessRights

performIncrFetchLocally