WebSyncRecommendationFolder

extends WebSyncSearchFolder

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

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

[Expand]

Inherited Methods

From class com.microstrategy.web.objects.WebSyncSearchFolder

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()
boolean	checkAccessFlags(int flags)
boolean	checkAccessRights(String feature)
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.
boolean	checkPrivilege(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.
WebOIDOMHandler	createDOMHandler()
WebOIDisplayXMLHandler	createDisplayXMLHandler()
WebOISAXParser	createSAXParser()
WebOIXMLBuilder	createXMLBuilder()
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
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()
String	getExtParams()
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.
String	getXMLForSave()
void	handleOiBody(SAXSupport parser, String local, Attributes attrs)
void	handleOiEnd(SAXSupport parser, String local, String buf)
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	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(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	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.
boolean	performIncrFetchLocally() This method call determines whether we should disregard any incremental fetch options specified on the call, and perform them locally.
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	postProcessOi(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.
void	reset()
void	saveXMLState(WebXMLBuilder builder, int howMuchState)
void	saveXMLState(StringBuffer buf, int howMuchState)
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()

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebFolder

abstract int	add(WebObjectInfo newObject) Adds the given `WebObjectInfo` object to the folder collection.
abstract int	add(WebObjectInfo newObject, int beforeKey) Adds the given `WebObjectInfo` object to the folder collection.
abstract int	add(WebObjectInfo newObject, WebObjectInfo beforeObject) Adds the given `WebObjectInfo` object to the folder collection.
abstract 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
abstract void	checkObjectVisibility(FolderBean fb) Removes from the folder shortcuts whose target is not in the list of requested types.
abstract void	clear() Clears all objects from the folder collection.
abstract boolean	contains(WebObjectInfo object) Returns true if the folder contains the given object, false if it does not.
abstract boolean	containsKey(int key) Returns true if the folder contains an item by the given key, false if not.
abstract Enumeration	elements() Returns a java.util.Enumeration object, which can be used to iterate through the folder.
abstract void	filterShortcuts(int[] types) Removes from the folder shortcuts whose target is not in the list of requested types.
abstract 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.
abstract WebObjectInfo	get(int index) Returns the object in the collection with the given index.
abstract int	getBlockBegin() Returns the current blockBegin setting, which is used for incremental fetch of folder contents.
abstract int	getBlockCount() Returns the current blockCount setting, which is used for incremental fetch of folder contents.
abstract int	getChildCount() Returns the child count, which is the total number of items in the collection.
abstract Tree<WebObjectInfo>	getChildrenInTree() Returns child units in a tree structure.
abstract boolean	getDereferenceShorcuts() Returns whether Shortcut objects are "dereferenced" in folder browsing requests.
abstract WebObjectFilter	getFilter()
abstract int	getFolderType() Returns the type of this folder, a value from `EnumDSSXMLFolderType`.
abstract boolean	getIsBrowsing() read a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
abstract WebObjectInfo	getItemByKey(int key) Returns the object in the collection with the given key.
abstract int	getLevel() Returns the current value of the level parameter.
abstract int	getOriginalChildCount() In case some types of shortcuts objects will be filtered out from the objectCollection.
abstract int	getQuickSearchFlag()
abstract WebFolder	getRoot() Returns a folder object representing the root folder of the project.
abstract int	getStyle() Returns the style in which the display XML of the folder will be output.
abstract SimpleList	getTypeRestrictions() Returns a collection of Integers which represent the set of object types that can be contained in the folder.
abstract boolean	isEmpty() Returns true if the folder object contains nothing, false if it is not empty.
abstract boolean	isNamedFolder(int folderName) Returns whether this folder is the named folder.
abstract boolean	isNonSchedulable()
abstract boolean	isReadOnly() Returns true if this folder is a read-only object, false if it is read/write.
abstract boolean	isRoot() Returns whether this object is the root folder.
abstract int	keyOf(WebObjectInfo object) Returns the key of the given object, if it exists in the collection.
abstract SimpleList	objectTypes() Returns a collection of Integers, which contains a non-repeating list of the types of objects which are contained in this folder.
abstract int	partialSubFolderCount() Returns the number of sub-folders in the current folder, within the blockBegin and blockCount constraints.
abstract void	remove(WebObjectInfo object) Removes the given object from the folder collection.
abstract void	remove(int index) Removes the object in the collection with the given index.
abstract void	removeItemByKey(int key) Removes the object in the collection with the given key.
abstract void	setBlockBegin(int blockBegin) Sets the blockBegin setting, which is used for incremental fetch of folder contents.
abstract void	setBlockCount(int blockCount) Sets the blockCount setting, which is used for incremental fetch of folder contents.
abstract void	setDereferenceShortcuts(boolean dereferenceShorcuts) Sets whether Shorcuts objects are "dereferenced" in folder browsing requests.
abstract void	setFilter(WebObjectFilter value)
abstract void	setIsBrowsing(boolean bf) set a flag to indicate whether we're browsing a folder Set only to get 'non-schedulable' flag on objects
abstract void	setLevel(int level) Sets the value of the level parameter.
abstract void	setQuickSearchFlag(int qsr) Read a QuickSearch flag returned in MetaDataSearch result xml node attribute and set to WebFolder object
abstract void	setStyle(int style) Sets the style in which the display XML of the folder will be output.
abstract int	size() Returns the number of objects in the folder.
abstract int	subFolderCount() Returns the number of sub-folders which exist in the current folder, regardless of blockCount.

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract 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.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Interfaces

Classes

Enums

Exceptions

WebSyncRecommendationFolder

Summary

Public Methods

public Enumeration syncRecommendactionResultsElements ()