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

All Implemented Interfaces:

KeyedObject, EnumWebPersistableState, Persistable, EnumWebObjectsFeatures, WebChangeJournalSearch, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite, WebSearch, EnumDSSXMLAccessRightFlags
```
public class WebChangeJournalSearchImpl
extends AbstractPersistable
implements WebChangeJournalSearch
```

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

Constructor Summary

Constructors
Constructor Description

WebChangeJournalSearchImpl(WebObjectsFactory _factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`_getObKey()`
`void`	`addDetails(boolean details)`	This method will add or remove details from the display unit.
`void`	`applyVisitor(DisplayUnitsVisitor visitor, boolean deep)`
`void`	`buildShortObjectAttributes(WebXMLBuilder builder)`
`void`	`buildShortXML(WebXMLBuilder builder)`
`boolean`	`canHighlight()`
`protected boolean`	`checkAccessFlags(int flags)`
`protected boolean`	`checkAccessRights(java.lang.String feature)`
`protected boolean`	`checkPrivilege(java.lang.String feature)`
`protected com.microstrategy.web.objects.WebOIDisplayXMLHandler`	`createDisplayXMLHandler()`
`protected com.microstrategy.web.objects.WebOIDOMHandler`	`createDOMHandler()`
`protected com.microstrategy.web.objects.WebOISAXParser`	`createSAXParser()`
`protected com.microstrategy.web.objects.WebOIXMLBuilder`	`createXMLBuilder()`
`protected void`	`doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)`
`WebFolder`	`doSynchronousQuickSearch()`	Do the Synchronous Quick Search
`WebFolder`	`doSynchronousQuickSearch(boolean searchCluster)`	Do the Synchronous Quick Search
`boolean`	`equals(WebObjectInfo otherOI)`
`boolean`	`equals(java.lang.Object otherObject)`
`java.lang.String`	`getAbbreviation()`	Returns the abbreviation of this object.
`java.lang.String`	`getAbbreviationPattern()`	Gets the abbreviation pattern that the Search object will search for.
`int`	`getAccessGranted()`	Returns the current access granted on this object, if available.
`int`	`getAccessRights()`	Returns the access rights of the object being searched for, that the search will be narrowed by.
`SimpleList`	`getAncestors()`	Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
`java.lang.String`	`getBeginTime()`
`java.lang.String`	`getBeginTransactionID()`
`int`	`getBlockBegin()`	Returns the blockBegin value for the objects that the search returns.
`int`	`getBlockCount()`	Returns the blockCount value for the objects that the search returns.
`int`	`getCardStatus()`	Returns the status of the hyper card.
`WebCertifiedInfo`	`getCertifiedInfo()`
`WebChangeJournalEntries`	`getChangeJournalResults()`	Attempts to get the change journal results of a search from the Intelligence Server.
`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`	`getDescription()`	Returns the description of the object.
`java.lang.String`	`getDescriptionPattern()`	Returns the description pattern that the search is currently limited to.
`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`	`getDomain()`	Returns the current domain for the search.
`java.lang.String`	`getEndTime()`
`java.lang.String`	`getEndTransactionID()`
`int`	`getExtendedType()`	The current extended type
`protected java.lang.String`	`getExtParams()`
`WebObjectsFactory`	`getFactory()`	Returns WebObjectsFactory
`int`	`getFirstObjectIndex()`	Returns the index to begin searching from.
`int`	`getFlags()`	Returns the flags which determine what data to populate upon calling populate.
`java.lang.String`	`getIconPath()`	Return the icon path for the object
`java.lang.String`	`getID()`	Returns the DSS ID of the object, if one exists.
`int`	`getMaxObjects()`	Returns the maximum number of objects the search is configured to return.
`int`	`getMaxWait()`	Returns the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
`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.
`java.lang.String`	`getNamePattern()`	Returns the pattern to search for in the name of the objects in metadata.
`boolean`	`getNonSchedulable()`	Get flag of whether the object is not schedulable
`int`	`getOtherNameTransCount()`	Returns the count of name translations for locales other than the current effective locale.
`int`	`getOutputType()`
`WebObjectInfo`	`getOwner()`	Returns a WebObjectInfo object which corresponds to the owner of this object.
`WebFolder`	`getParent()`	Returns the parent folder of the current object, if it exists.
`int`	`getPollingFrequency()`	Returns the current polling frequency, in milliseconds.
`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.
`EnumDSSXMLQuickSearchCertifiedStatus`	`getQuickSearchCertifiedStatus()`	Get the certified status criteria for the quick search
`java.util.List<java.lang.Integer>`	`getQuickSearchDocumentTypes()`	Get a list of document types that the user wants to search for.
`EnumDSSXMLQuickSearchEnabledStatus`	`getQuickSearchEnabledStatus()`	Get the user enabled status for quick search.
`EnumDSSXMLQuickSearchMode`	`getQuickSearchMode()`	Get the search mode for quick search.
`EnumDSSXMLQuickSearchVisibility`	`getQuickSearchVisibility()`	Get the include hidden mode to be used for the quick search
`WebRecommendationInfo`	`getRecommendationInfo()`	This contains all the information related to a recommendation search
`WebFolder`	`getResults()`	Attempts to get the results of a search from the Intelligence Server.
`WebFolder`	`getResults(boolean dereferenceShortcuts)`
`int`	`getScope()`	Returns the current scope for the search.
`java.util.List<WebFolder>`	`getSearchExcludeRoots()`	Returns the excluded folders for the search
`java.lang.String`	`getSearchFields()`	Return current setting of Search Fields
`int`	`getSearchFlags()`	Returns the currently set search flags.
`java.lang.String`	`getSearchID()`	Returns the search ID of the last search submitted by this object, or the last time setSearchID was called.
`java.lang.String`	`getSearchOwner()`	Returns the value of the search owner restriction on the search, if it is currently set.
`java.lang.String`	`getSearchRoot()`	Returns the root folder ID that the search is limited to, if applicable.
`int`	`getSearchType()`	Return current setting of Search Type
`WebObjectSecurity`	`getSecurity()`	Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
`int`	`getSelectedCount()`
`int`	`getState()`	Returns the state of the object.
`int`	`getStateClear()`	Returns the object states that the search is prohibited from returning.
`int`	`getStateSet()`	Returns the object states that the search will be limited to.
`int`	`getStatus()`	Returns the status of the last getResults call which was made.
`int`	`getSubType()`	Returns the subtype of the object.
`java.lang.String`	`getTargetUserGroupId()`	Get the search target group id.
`int`	`getType()`	Returns the type of this object.
`java.lang.String`	`getVersionID()`	Returns the Version ID of the object, if one exists.
`WebViewMediaSettings`	`getViewMediaSettings()`
`int`	`getVisualizationViewMode()`
`java.lang.String`	`getXML()`	Returns the XML representation of this object.
`java.lang.String`	`getXML(boolean encode)`	Returns the XML representation of this object.
`protected java.lang.String`	`getXMLForSave()`
`protected void`	`handleOiBody(SAXSupport parser, java.lang.String local, org.xml.sax.Attributes attrs)`
`protected void`	`handleOiEnd(SAXSupport parser, java.lang.String local, java.lang.String buf)`
`boolean`	`hasDetails()`	Returns whether this display unit currently has details enabled.
`int`	`hashCode()`
`boolean`	`hasOwner()`
`void`	`highlightUnit()`	Sets this display unit to be highlighted.
`void`	`highlightUnit(boolean details)`	Sets this display unit to be highlighted.
`boolean`	`isAncestorNamedFolder(int folderName)`	Returns whether the named folder is this object's ancestor.
`boolean`	`isAsync()`	Returns whether getResults will be asynchronous.
`protected boolean`	`isBodyDirty()`
`boolean`	`isDirty()`	Returns whether this object has been modified to be different from the object in metadata.
`boolean`	`isEmbedded()`
`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`	`isGettingTreeInfo()`	Gets the setting about whether the search result would include the browsing tree structure or not.
`boolean`	`isHidden()`	Returns whether the object is a hidden object.
`boolean`	`isHighlighted()`	Returns whether this unit is highlighted.
`boolean`	`isNew()`	Returns whether this object is newly created at client side, which is not in the metadata.
`boolean`	`isObjectInfo()`	Returns true if underlying Web Object can be cast to `WebObjectInfo`.
`boolean`	`isPopulated()`	Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
`boolean`	`isQuickSearch()`	Gets the setting about whether the search should be handled by the new quick search engine.
`boolean`	`isSelected()`	Returns whether this display unit is selected.
`boolean`	`isSynchronousQuickSearch()`	Gets the setting about whether the search should be handled by the Synchronous quick search engine.
`void`	`notUsedBy(int type)`	The resulting objects of the search is NOT used by objects of the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
`void`	`notUses(int type)`	The resulting objects of the search does NOT use the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
`protected boolean`	`performIncrFetchLocally()`	Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
`void`	`populate()`	Populates the fields on this object by asking the Intelligence Server for the object definition.
`void`	`populate(java.lang.String xml)`	Populates the fields on this object by loading the given object definition XML.
`protected void`	`postProcessOi(com.microstrategy.web.objects.WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)`
`void`	`purge()`	Purges the search whose ID is set on this WebSearch object from the Intelligence Server's memory.
`void`	`reset()`	Resets all member variables on this object, which causes a reset of the search criteria.
`protected void`	`saveXMLState(WebXMLBuilder builder, int howMuchState)`
`protected void`	`saveXMLState(java.lang.StringBuffer buf, int howMuchState)`
`void`	`setAbbreviation(java.lang.String ab)`
`void`	`setAbbreviationPattern(java.lang.String _abbreviationPattern)`	Sets the abbreviation pattern of objects that a search will return.
`void`	`setAccessRights(int _accessRights)`	This will set the access rights that the search results will be limited by.
`void`	`setAffectedObjects(java.util.List<WebObjectInfo> _affectedObjects)`	Set the restriction about affected objects for the change journal entries that the search returns.
`void`	`setAffectedProjects(java.util.List<WebObjectInfo> _affectedProjects)`	Set the restriction about affected projects for the change journal entries that the search returns.
`void`	`setApplicationTypes(java.util.List<java.lang.Integer> _applicationTypes)`	Set the restriction about application types for the change journal entries that the search returns.
`void`	`setAsync(boolean _async)`	Sets whether getResults will be asynchronous.
`void`	`setBeginTime(java.lang.String _beginTime)`	Set the begin time value for the change journal entries that the search returns.
`void`	`setBeginTransactionID(java.lang.String _transactionID)`	Set the begin transaction id value for the change journal entries that the search returns.
`void`	`setBlockBegin(int _blockBegin)`	Sets the blockBegin value for the objects that the search returns.
`void`	`setBlockCount(int _blockCount)`	Sets the blockCount value for the objects that the search returns.
`void`	`setCardStatus(int cardStatus)`
`void`	`setCertifiedInfo(WebCertifiedInfo certifiedInfo)`
`void`	`setChangeTypes(java.util.List<java.lang.Integer> _changeTypes)`	Set the restriction about transaction types for the change journal entries that the search returns.
`void`	`setComments(java.lang.String[] _comments)`	Set the long description of the object as an array of strings.
`void`	`setCreatedModifiedByDate(java.lang.String _beginTime, java.lang.String _endTime)`	Sets the created/modified by date range of the search criteria.
`void`	`setCreatedModifiedByDate(java.util.Date _beginTime, java.util.Date _endTime)`	Sets the created/modified by date range of the search criteria.
`void`	`setCreatedModifiedByInterval(int _timeInterval, int _intervalUnit)`	Sets the interval for the created/modified by time for the search.
`void`	`setDataSources(java.lang.String _dataSources)`
`void`	`setDescription(java.lang.String _description)`	Sets the description of the object.
`void`	`setDescriptionPattern(java.lang.String _descriptionPattern)`	Sets the description pattern that the search will be limited to.
`void`	`setDisplayName(java.lang.String _displayName)`	This method will set the value of the display name.
`void`	`setDomain(int _domain)`	Sets the domain that the search will be limited to.
`void`	`setEndTime(java.lang.String _endTime)`	Set the end time value for the change journal entries that the search returns.
`void`	`setEndTransactionID(java.lang.String _transactionID)`	Set the end transaction id value for the change journal entries that the search returns.
`void`	`setExtendedType(int extendedType)`	Set the current extended type
`void`	`setFirstObjectIndex(int _firstObjectIndex)`	Sets the index to begin searching from.
`void`	`setFlags(int _flags)`	Sets the flags which determine what data to populate upon calling populate.
`void`	`setGettingTreeInfo(boolean gettingTreeInfo)`	Sets the setting about whether the search result would include the browsing tree structure or not.
`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`	`setMachines(java.util.List<java.lang.String> _machines)`	Set the restriction about machines for the change journal entries that the search returns.
`void`	`setMaxObjects(int _maxObjects)`	Sets the maximum number of objects that the search will return.
`void`	`setMaxWait(int millis)`	Sets the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
`void`	`setName(java.lang.String _name)`
`void`	`setNamePattern(java.lang.String _namePattern)`	Sets the pattern to search for in the name of the objects in metadata.
`void`	`setNonSchedulable(boolean non_schedulable)`	Set flag of whether the object is not schedulable
`void`	`setOutputType(int _outputType)`
`void`	`setPollingFrequency(int millis)`	Sets the current polling frequency, in milliseconds.
`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`	`setQuickSearch(boolean quickSearch)`	Sets the setting about whether the search should be handled by the new quick search engine.
`void`	`setQuickSearchCertifiedStatus(EnumDSSXMLQuickSearchCertifiedStatus quickSearchCertifiedStatus)`	Set the certified status criteria to be used for the quick search
`void`	`setQuickSearchDocumentTypes(java.util.List<java.lang.Integer> types)`	Set a list of document types that the user wants to search for.
`void`	`setQuickSearchEnabledStatus(EnumDSSXMLQuickSearchEnabledStatus userEnabledStatus)`	Set the user enabled status for quick search.
`void`	`setQuickSearchMode(EnumDSSXMLQuickSearchMode quickSearchMode)`	Set the search mode for quick search.
`void`	`setQuickSearchVisibility(EnumDSSXMLQuickSearchVisibility quickSearchVisibility)`	Set the include hidden mode to be used for the quick search
`void`	`setRecommendationInfo(WebRecommendationInfo recommendationInfo)`
`void`	`setScope(int _scope)`	Sets the scope that the search will be limited to.
`void`	`setSearchFields(java.lang.String searchFields)`	Sets the setting for the new quick search engine.
`void`	`setSearchFlags(int _searchFlags)`	Sets the search flags for the search.
`void`	`setSearchID(java.lang.String _searchID)`	Sets the search ID, which will be used when getResults is called.
`void`	`setSearchOwner(java.lang.String _searchOwner)`	Sets the value of the owner restriction on the search.
`void`	`setSearchRoot(java.lang.String _searchRoot)`	Sets the root folder that the search will be limited to.
`void`	`setSearchType(int searchType)`	Sets the setting for the new quick search engine.
`void`	`setSelected(boolean selected)`	Sets the current unit's selection status.
`void`	`setSessions(java.util.List<java.lang.String> _sessions)`	Set the restriction about sessions for the change journal entries that the search returns.
`void`	`setStateClear(int _stateClear)`	Sets the object states that the search is prohibited from returning.
`void`	`setStateSet(int _stateSet)`	Sets the object states that should be returned in the search.
`void`	`setTargetUserGroupId(java.lang.String targetUserGroupId)`	Set the search target group id.
`void`	`setTransactionTypes(java.util.List<java.lang.Integer> _transactionTypes)`	Set the restriction about transaction types for the change journal entries that the search returns.
`void`	`setUsers(java.util.List<WebObjectInfo> _users)`	Set the restriction about users for the change journal entries that the search returns.
`void`	`submit()`	Submits the current state of this search object to the Intelligence Server.
`void`	`submit(java.lang.String newSearchXML)`	Submits the given search XML to the Intelligence Server.
`java.lang.String`	`toString()`
`SimpleList`	`types()`	Returns a `SimpleList` from which types can be added or removed.
`SimpleList`	`usedBy()`	Returns a `SimpleList` which can be used to add or remove objects which constrain the search to only return objects which are used by the given object(s).
`void`	`usedBy(int type)`	The resulting objects of the search is used by objects of the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
`SimpleList`	`uses()`	Returns a `SimpleList` which can be used to add or remove objects which constrain the search to only return objects which use the given object(s).
`void`	`uses(int type)`	The resulting objects of the search uses the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).

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.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

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

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

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

Methods inherited from interface com.microstrategy.web.objects.WebSearch
doSynchronousQuickSearch, doSynchronousQuickSearch, getAbbreviationPattern, getAccessRights, getBlockBegin, getBlockCount, getDescriptionPattern, getDomain, getFirstObjectIndex, getMaxObjects, getMaxWait, getNamePattern, getPollingFrequency, getQuickSearchCertifiedStatus, getQuickSearchDocumentTypes, getQuickSearchEnabledStatus, getQuickSearchMode, getQuickSearchVisibility, getResults, getScope, getSearchExcludeRoots, getSearchFields, getSearchFlags, getSearchID, getSearchOwner, getSearchRoot, getSearchType, getStateClear, getStateSet, getStatus, getTargetUserGroupId, isAsync, isGettingTreeInfo, isQuickSearch, isSynchronousQuickSearch, notUsedBy, notUses, purge, reset, setAbbreviationPattern, setAccessRights, setAsync, setBlockBegin, setBlockCount, setCreatedModifiedByDate, setCreatedModifiedByDate, setCreatedModifiedByInterval, setDescriptionPattern, setDomain, setFirstObjectIndex, setGettingTreeInfo, setMaxObjects, setMaxWait, setNamePattern, setPollingFrequency, setQuickSearch, setQuickSearchCertifiedStatus, setQuickSearchDocumentTypes, setQuickSearchEnabledStatus, setQuickSearchMode, setQuickSearchVisibility, setScope, setSearchFields, setSearchFlags, setSearchID, setSearchOwner, setSearchRoot, setSearchType, setStateClear, setStateSet, setTargetUserGroupId, submit, types, usedBy, usedBy, uses, uses

- Constructor Detail
  - WebChangeJournalSearchImpl
```
public WebChangeJournalSearchImpl(WebObjectsFactory _factory)
```
- Method Detail
  - setUsers
```
public void setUsers(java.util.List<WebObjectInfo> _users)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about users for the change journal entries that the search returns.
    
    Specified by:
    
    setUsers in interface WebChangeJournalSearch
    
    Parameters:
    
    _users - . A list of the users that used to filter the change journal result.
  - setMachines
```
public void setMachines(java.util.List<java.lang.String> _machines)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about machines for the change journal entries that the search returns.
    
    Specified by:
    
    setMachines in interface WebChangeJournalSearch
    
    Parameters:
    
    _machines - . A list of the machine names that used to filter the change journal result.
  - setSessions
```
public void setSessions(java.util.List<java.lang.String> _sessions)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about sessions for the change journal entries that the search returns.
    
    Specified by:
    
    setSessions in interface WebChangeJournalSearch
    
    Parameters:
    
    _sessions - . A list of the sessions that used to filter the change journal result.
  - setAffectedObjects
```
public void setAffectedObjects(java.util.List<WebObjectInfo> _affectedObjects)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about affected objects for the change journal entries that the search returns.
    
    Specified by:
    
    setAffectedObjects in interface WebChangeJournalSearch
    
    Parameters:
    
    _affectedObjects - . A list of the affected objects that used to filter the change journal result.
  - setAffectedProjects
```
public void setAffectedProjects(java.util.List<WebObjectInfo> _affectedProjects)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about affected projects for the change journal entries that the search returns.
    
    Specified by:
    
    setAffectedProjects in interface WebChangeJournalSearch
    
    Parameters:
    
    _affectedProjects - . A list of the projects that used to filter the change journal result.
  - setTransactionTypes
```
public void setTransactionTypes(java.util.List<java.lang.Integer> _transactionTypes)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about transaction types for the change journal entries that the search returns.
    
    Specified by:
    
    setTransactionTypes in interface WebChangeJournalSearch
    
    Parameters:
    
    _transactionTypes - . A list of the transaction types that used to filter the change journal result.
  - setChangeTypes
```
public void setChangeTypes(java.util.List<java.lang.Integer> _changeTypes)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about transaction types for the change journal entries that the search returns.
    
    Specified by:
    
    setChangeTypes in interface WebChangeJournalSearch
    
    Parameters:
    
    _changeTypes - . A list of the change types that used to filter the change journal result.
  - setApplicationTypes
```
public void setApplicationTypes(java.util.List<java.lang.Integer> _applicationTypes)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the restriction about application types for the change journal entries that the search returns.
    
    Specified by:
    
    setApplicationTypes in interface WebChangeJournalSearch
    
    Parameters:
    
    _applicationTypes - . A list of the application types that used to filter the change journal result.
  - setBeginTime
```
public void setBeginTime(java.lang.String _beginTime)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the begin time value for the change journal entries that the search returns.
    
    Specified by:
    
    setBeginTime in interface WebChangeJournalSearch
    
    Parameters:
    
    _beginTime - . The begin time of the change journal search restriction.
  - getBeginTime
```
public java.lang.String getBeginTime()
```
  - setEndTime
```
public void setEndTime(java.lang.String _endTime)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the end time value for the change journal entries that the search returns.
    
    Specified by:
    
    setEndTime in interface WebChangeJournalSearch
    
    Parameters:
    
    _endTime - . The end time of the change journal search restriction.
  - getEndTime
```
public java.lang.String getEndTime()
```
  - setBeginTransactionID
```
public void setBeginTransactionID(java.lang.String _transactionID)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the begin transaction id value for the change journal entries that the search returns.
    
    Specified by:
    
    setBeginTransactionID in interface WebChangeJournalSearch
    
    Parameters:
    
    _transactionID - . The begin transaction id of the change journal search restriction.
  - getBeginTransactionID
```
public java.lang.String getBeginTransactionID()
```
  - setEndTransactionID
```
public void setEndTransactionID(java.lang.String _transactionID)
```
    Description copied from interface: WebChangeJournalSearch
    
    Set the end transaction id value for the change journal entries that the search returns.
    
    Specified by:
    
    setEndTransactionID in interface WebChangeJournalSearch
    
    Parameters:
    
    _transactionID - . The end transaction id of the change journal search restriction.
  - getEndTransactionID
```
public java.lang.String getEndTransactionID()
```
  - submit
```
public void submit()
            throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Submits the current state of this search object to the Intelligence Server. This will cause the search ID to be set to the search ID which results from this submission.
    
    Specified by:
    
    submit in interface WebSearch
    
    Throws:
    
    WebObjectsException - Thrown if the search could not be submitted to the Intelligence Server.
  - getChangeJournalResults
```
public WebChangeJournalEntries getChangeJournalResults()
                                                throws WebObjectsException
```
    Description copied from interface: WebChangeJournalSearch
    
    Attempts to get the change journal results of a search from the Intelligence Server. The search ID used will be the one set on this WebChangeJournalSearch object.
    
    Specified by:
    
    getChangeJournalResults in interface WebChangeJournalSearch
    
    Returns:
    
    A WebChangeJournalEntries object representing the collection of WebChangeJournalEntry returned from the search, or null if the search is not yet ready.
    
    Throws:
    
    WebObjectsException - Signals an error in the execution or retrieval of results of the search.
  - getAbbreviationPattern
```
public java.lang.String getAbbreviationPattern()
```
    Description copied from interface: WebSearch
    
    Gets the abbreviation pattern that the Search object will search for. If this is an empty string, then the search will not be restricted on the objects' abbreviation pattern.
    
    Specified by:
    
    getAbbreviationPattern in interface WebSearch
    
    Returns:
    
    The abbreviation pattern to search for.
    
    See Also:
    
    WebSearch.setAbbreviationPattern(java.lang.String)
  - setAbbreviationPattern
```
public void setAbbreviationPattern(java.lang.String _abbreviationPattern)
```
    Description copied from interface: WebSearch
    
    Sets the abbreviation pattern of objects that a search will return.
    
    Specified by:
    
    setAbbreviationPattern in interface WebSearch
    
    Parameters:
    
    _abbreviationPattern - Abbreviation pattern to search for. An empty string will ensure that no filtering of the search results is done on the abbreviation pattern.
    
    See Also:
    
    WebSearch.getAbbreviationPattern()
  - getAccessRights
```
public int getAccessRights()
```
    Description copied from interface: WebSearch
    
    Returns the access rights of the object being searched for, that the search will be narrowed by. This value corresponds to those in EnumDSSXMLAccessRightFlags.
    
    Specified by:
    
    getAccessRights in interface WebSearch
    
    Returns:
    
    An int corresponding to the access rights that the search will be filtered on.
    
    See Also:
    
    WebSearch.setAccessRights(int)
  - setAccessRights
```
public void setAccessRights(int _accessRights)
```
    Description copied from interface: WebSearch
    
    This will set the access rights that the search results will be limited by.
    
    Specified by:
    
    setAccessRights in interface WebSearch
    
    Parameters:
    
    _accessRights - The value to search for. This is the bitwise OR of values from EnumDSSXMLAccessRightFlags.
    
    See Also:
    
    WebSearch.getAccessRights()
  - getBlockBegin
```
public int getBlockBegin()
```
    Description copied from interface: WebSearch
    
    Returns the blockBegin value for the objects that the search returns. This is used for incremental fetching of the search results, and tells which item in the search should be the first one of the subset of search results that is to be returned.
    The default value of blockBegin is 1, meaning return items starting with the first object found.
    
    Specified by:
    
    getBlockBegin in interface WebSearch
    
    Returns:
    
    The current setting for the first element to return from the search.
    
    See Also:
    
    WebSearch.setBlockBegin(int)
  - setBlockBegin
```
public void setBlockBegin(int _blockBegin)
```
    Description copied from interface: WebSearch
    
    Sets the blockBegin value for the objects that the search returns. This is used for incremental fetching of the search results, and tells which item in the search should be the first one of the subset of search results that is to be returned.
    
    Specified by:
    
    setBlockBegin in interface WebSearch
    
    Parameters:
    
    _blockBegin - The first element in the result list that should be returned from the search.
    
    See Also:
    
    WebSearch.getBlockBegin()
  - getBlockCount
```
public int getBlockCount()
```
    Description copied from interface: WebSearch
    
    Returns the blockCount value for the objects that the search returns. This is used for incremental fetching of the search results, and tells how many items should be returned in the subset of search results that is to be returned.
    The default value of blockCount is -1, meaning return all items.
    
    Specified by:
    
    getBlockCount in interface WebSearch
    
    Returns:
    
    The current setting for the number of elements, starting from the blockBegin element, to return from the search. This only affects the window of data that is returned by the search - it does not limit the actual number of results from the search.
    
    See Also:
    
    WebSearch.setBlockCount(int)
  - setBlockCount
```
public void setBlockCount(int _blockCount)
```
    Description copied from interface: WebSearch
    
    Sets the blockCount value for the objects that the search returns. This is used for incremental fetching of the search results, and tells how many items should be returned in the subset of search results that is to be returned.
    
    Specified by:
    
    setBlockCount in interface WebSearch
    
    Parameters:
    
    _blockCount - The new setting to use for the number of elements, starting from the blockBegin element, to return from the search. This only affects the window of data that is returned by the search - it does not limit the actual number of results from the search.
    
    See Also:
    
    WebSearch.getBlockCount()
  - getDescriptionPattern
```
public java.lang.String getDescriptionPattern()
```
    Description copied from interface: WebSearch
    
    Returns the description pattern that the search is currently limited to. An empty string denotes that the search will not be limited by the description of the objects.
    
    Specified by:
    
    getDescriptionPattern in interface WebSearch
    
    Returns:
    
    The current description pattern to search for.
    
    See Also:
    
    WebSearch.setDescriptionPattern(java.lang.String)
  - setDescriptionPattern
```
public void setDescriptionPattern(java.lang.String _descriptionPattern)
```
    Description copied from interface: WebSearch
    
    Sets the description pattern that the search will be limited to. An empty string denotes that the search will not be limited by the description of the objects.
    
    Specified by:
    
    setDescriptionPattern in interface WebSearch
    
    Parameters:
    
    _descriptionPattern - The description pattern to use in the search.
    
    See Also:
    
    WebSearch.getDescriptionPattern()
  - getDomain
```
public int getDomain()
```
    Description copied from interface: WebSearch
    
    Returns the current domain for the search. The domain tells the scope in which the search will be performed.
    The default domain is EnumDSSXMLSearchDomain.DssXmlSearchDomainProject.
    
    Specified by:
    
    getDomain in interface WebSearch
    
    Returns:
    
    An int corresponding to a value in EnumDSSXMLSearchDomain.
    
    See Also:
    
    WebSearch.setDomain(int)
  - setDomain
```
public void setDomain(int _domain)
```
    Description copied from interface: WebSearch
    
    Sets the domain that the search will be limited to. By default, the domain is EnumDSSXMLSearchDomain.DssXmlSearchDomainProject.
    
    Specified by:
    
    setDomain in interface WebSearch
    
    Parameters:
    
    _domain - The new value for the domain, coming from the EnumDSSXMLSearchDomain enumeration.
    
    See Also:
    
    WebSearch.getDomain()
  - getScope
```
public int getScope()
```
    Description copied from interface: WebSearch
    
    Returns the current scope for the search.
    The default scope is EnumDSSXMLSearchScope.DssXmlSearchScopeRootedObjects.
    
    Specified by:
    
    getScope in interface WebSearch
    
    Returns:
    
    An int corresponding to a value in EnumDSSXMLSearchScope.
    
    See Also:
    
    WebSearch.setScope(int)
  - setScope
```
public void setScope(int _scope)
```
    Description copied from interface: WebSearch
    
    Sets the scope that the search will be limited to. By default, scope is EnumDSSXMLSearchScope.DssXmlSearchScopeRootedObjects.
    
    Specified by:
    
    setScope in interface WebSearch
    
    Parameters:
    
    _scope - domain The new value for the scope, coming from the EnumDSSXMLSearchScope enumeration.
    
    See Also:
    
    WebSearch.getScope()
  - getSearchFlags
```
public int getSearchFlags()
```
    Description copied from interface: WebSearch
    
    Returns the currently set search flags.
    The default value of the search flags is 0.
    
    Specified by:
    
    getSearchFlags in interface WebSearch
    
    Returns:
    
    A value corresponding to a bitwise OR from the enumeration class EnumDSSXMLSearchFlags.
    
    See Also:
    
    WebSearch.setSearchFlags(int)
  - setSearchFlags
```
public void setSearchFlags(int _searchFlags)
```
    Description copied from interface: WebSearch
    
    Sets the search flags for the search.
    
    Specified by:
    
    setSearchFlags in interface WebSearch
    
    Parameters:
    
    _searchFlags - A value corresponding to a bitwise OR from the enumeration class EnumDSSXMLSearchFlags.
    
    See Also:
    
    WebSearch.getSearchFlags()
  - getMaxObjects
```
public int getMaxObjects()
```
    Description copied from interface: WebSearch
    
    Returns the maximum number of objects the search is configured to return. By default, this value is -1, meaning return all objects, but it can be changed by calling setMaxObjects.
    
    Specified by:
    
    getMaxObjects in interface WebSearch
    
    Returns:
    
    The maximum number of objects a search will return.
    
    See Also:
    
    WebSearch.setMaxObjects(int)
  - setMaxObjects
```
public void setMaxObjects(int _maxObjects)
```
    Description copied from interface: WebSearch
    
    Sets the maximum number of objects that the search will return. Default is -1, meaning return all objects.
    
    Specified by:
    
    setMaxObjects in interface WebSearch
    
    Parameters:
    
    _maxObjects - The maximum number of objects to return from the search.
    
    See Also:
    
    WebSearch.getMaxObjects()
  - getOutputType
```
public int getOutputType()
```
  - setOutputType
```
public void setOutputType(int _outputType)
```
  - getFirstObjectIndex
```
public int getFirstObjectIndex()
```
    Description copied from interface: WebSearch
    
    Returns the index to begin searching from. By default, this value is 1, meaning search from beginning, but it can be changed by calling setFirstObjectIndex.
    
    Specified by:
    
    getFirstObjectIndex in interface WebSearch
    
    Returns:
    
    The index to begin searching from.
    
    See Also:
    
    WebSearch.setFirstObjectIndex(int)
  - setFirstObjectIndex
```
public void setFirstObjectIndex(int _firstObjectIndex)
```
    Description copied from interface: WebSearch
    
    Sets the index to begin searching from. Default is 1, meaning search from beginning.
    
    Specified by:
    
    setFirstObjectIndex in interface WebSearch
    
    Parameters:
    
    _firstObjectIndex - The index to begin searching from.
    
    See Also:
    
    WebSearch.getFirstObjectIndex()
  - getNamePattern
```
public java.lang.String getNamePattern()
```
    Description copied from interface: WebSearch
    
    Returns the pattern to search for in the name of the objects in metadata.
    
    Specified by:
    
    getNamePattern in interface WebSearch
    
    Returns:
    
    The name pattern that will be searched for.
    
    See Also:
    
    WebSearch.setNamePattern(java.lang.String)
  - setNamePattern
```
public void setNamePattern(java.lang.String _namePattern)
```
    Description copied from interface: WebSearch
    
    Sets the pattern to search for in the name of the objects in metadata.
    
    Specified by:
    
    setNamePattern in interface WebSearch
    
    Parameters:
    
    _namePattern - The name pattern that will be searched for.
    
    See Also:
    
    WebSearch.getNamePattern()
  - getSearchOwner
```
public java.lang.String getSearchOwner()
```
    Description copied from interface: WebSearch
    
    Returns the value of the search owner restriction on the search, if it is currently set.
    
    Specified by:
    
    getSearchOwner in interface WebSearch
    
    Returns:
    
    The user whose objects the search is limited to.
    
    See Also:
    
    WebSearch.setSearchOwner(java.lang.String)
  - setSearchOwner
```
public void setSearchOwner(java.lang.String _searchOwner)
```
    Description copied from interface: WebSearch
    
    Sets the value of the owner restriction on the search.
    
    Specified by:
    
    setSearchOwner in interface WebSearch
    
    Parameters:
    
    _searchOwner - The user whose objects the search is limited to.
    
    See Also:
    
    WebSearch.getSearchOwner()
  - getSearchRoot
```
public java.lang.String getSearchRoot()
```
    Description copied from interface: WebSearch
    
    Returns the root folder ID that the search is limited to, if applicable.
    
    Specified by:
    
    getSearchRoot in interface WebSearch
    
    Returns:
    
    The folder ID that is to be used as the root of the search.
    
    See Also:
    
    WebSearch.setSearchRoot(java.lang.String)
  - setSearchRoot
```
public void setSearchRoot(java.lang.String _searchRoot)
```
    Description copied from interface: WebSearch
    
    Sets the root folder that the search will be limited to. Requires an object ID corresponding to a folder.
    
    Specified by:
    
    setSearchRoot in interface WebSearch
    
    Parameters:
    
    _searchRoot - The folder ID of a folder that will be used as the root of the search.
    
    See Also:
    
    WebSearch.getSearchRoot()
  - getStateClear
```
public int getStateClear()
```
    Description copied from interface: WebSearch
    
    Returns the object states that the search is prohibited from returning. Value comes from the bitwise OR of values from EnumDSSXMLObjectState. The default value is 0.
    
    Specified by:
    
    getStateClear in interface WebSearch
    
    Returns:
    
    The current value for the clear states.
    
    See Also:
    
    WebSearch.setStateClear(int)
  - setStateClear
```
public void setStateClear(int _stateClear)
```
    Description copied from interface: WebSearch
    
    Sets the object states that the search is prohibited from returning.
    
    Specified by:
    
    setStateClear in interface WebSearch
    
    Parameters:
    
    _stateClear - An int corresponding to the bitwise OR of values from EnumDSSXMLObjectState. These states will not be in the search result set.
    
    See Also:
    
    WebSearch.getStateClear()
  - getStateSet
```
public int getStateSet()
```
    Description copied from interface: WebSearch
    
    Returns the object states that the search will be limited to. Value comes from the bitwise OR of values from EnumDSSXMLObjectState. The default value is 0.
    
    Specified by:
    
    getStateSet in interface WebSearch
    
    Returns:
    
    The current value for the set states.
    
    See Also:
    
    WebSearch.setStateSet(int)
  - setStateSet
```
public void setStateSet(int _stateSet)
```
    Description copied from interface: WebSearch
    
    Sets the object states that should be returned in the search.
    
    Specified by:
    
    setStateSet in interface WebSearch
    
    Parameters:
    
    _stateSet - An int corresponding to the bitwise OR of values from EnumDSSXMLObjectState. Only objects with these states will be in the search result.
    
    See Also:
    
    WebSearch.getStateSet()
  - setCreatedModifiedByDate
```
public void setCreatedModifiedByDate(java.lang.String _beginTime,
                                     java.lang.String _endTime)
                              throws java.lang.IllegalArgumentException
```
    Description copied from interface: WebSearch
    
    Sets the created/modified by date range of the search criteria.
    
    Specified by:
    
    setCreatedModifiedByDate in interface WebSearch
    
    Parameters:
    
    _beginTime - A string representing the beginning date of the range.
    
    _endTime - A string representing the ending date of the range.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if one of the arguments is null.
  - setCreatedModifiedByDate
```
public void setCreatedModifiedByDate(java.util.Date _beginTime,
                                     java.util.Date _endTime)
                              throws java.lang.IllegalArgumentException
```
    Description copied from interface: WebSearch
    
    Sets the created/modified by date range of the search criteria.
    
    Specified by:
    
    setCreatedModifiedByDate in interface WebSearch
    
    Parameters:
    
    _beginTime - A java.util.Date set to the beginning date of the range.
    
    _endTime - A java.util.Date set to the ending date of the range.
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if one of the arguments is null.
  - setCreatedModifiedByInterval
```
public void setCreatedModifiedByInterval(int _timeInterval,
                                         int _intervalUnit)
```
    Description copied from interface: WebSearch
    
    Sets the interval for the created/modified by time for the search. This interval is measured from the time of the search, and the intervalUnit determines what the time unit on timeInterval is.
    
    Specified by:
    
    setCreatedModifiedByInterval in interface WebSearch
    
    Parameters:
    
    _timeInterval - The number of intervalUnits from the time of the search to filter the search results with.
    
    _intervalUnit - The unit to use for the search. Comes from EnumDSSXMLSearchUnit.
  - types
```
public SimpleList types()
```
    Description copied from interface: WebSearch
    
    Returns a SimpleList from which types can be added or removed. Note that the SimpleList returned can only have java.lang.Integer objects added to it.
    
    Specified by:
    
    types in interface WebSearch
    
    Returns:
    
    A SimpleList reflecting the types of objects which will be searched for.
  - usedBy
```
public SimpleList usedBy()
```
    Description copied from interface: WebSearch
    
    Returns a SimpleList which can be used to add or remove objects which constrain the search to only return objects which are used by the given object(s). Note that the SimpleList returned can only have WebObjectInfo objects added to it.
    
    Specified by:
    
    usedBy in interface WebSearch
    
    Returns:
    
    A SimpleList reflecting the used-by objects which will constrain the search.
  - usedBy
```
public void usedBy(int type)
```
    Description copied from interface: WebSearch
    
    The resulting objects of the search is used by objects of the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
    
    Specified by:
    
    usedBy in interface WebSearch
    
    Parameters:
    
    type - specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
  - notUsedBy
```
public void notUsedBy(int type)
```
    Description copied from interface: WebSearch
    
    The resulting objects of the search is NOT used by objects of the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
    
    Specified by:
    
    notUsedBy in interface WebSearch
    
    Parameters:
    
    type - specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
  - uses
```
public SimpleList uses()
```
    Description copied from interface: WebSearch
    
    Returns a SimpleList which can be used to add or remove objects which constrain the search to only return objects which use the given object(s). Note that the SimpleList returned can only have WebObjectInfo objects added to it.
    
    Specified by:
    
    uses in interface WebSearch
    
    Returns:
    
    A SimpleList reflecting the uses objects which will constrain the search.
  - uses
```
public void uses(int type)
```
    Description copied from interface: WebSearch
    
    The resulting objects of the search uses the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
    
    Specified by:
    
    uses in interface WebSearch
    
    Parameters:
    
    type - specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
  - notUses
```
public void notUses(int type)
```
    Description copied from interface: WebSearch
    
    The resulting objects of the search does NOT use the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
    
    Specified by:
    
    notUses in interface WebSearch
    
    Parameters:
    
    type - specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
  - doSynchronousQuickSearch
```
public WebFolder doSynchronousQuickSearch()
                                   throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Do the Synchronous Quick Search
    
    Specified by:
    
    doSynchronousQuickSearch in interface WebSearch
    
    Returns:
    
    A folder object representing the folder returned from the search, or null if the search is not yet ready.
    
    Throws:
    
    WebObjectsException - Thrown if the search could not be submitted to the Intelligence Server.
  - doSynchronousQuickSearch
```
public WebFolder doSynchronousQuickSearch(boolean searchCluster)
                                   throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Do the Synchronous Quick Search
    
    Specified by:
    
    doSynchronousQuickSearch in interface WebSearch
    
    Parameters:
    
    searchCluster - , if passing searchCluster as true, the entire cluster will be searched
    
    Returns:
    
    A folder object representing the folder returned from the search, or null if the search is not yet ready.
    
    Throws:
    
    WebObjectsException - Thrown if the search could not be submitted to the Intelligence Server.
  - submit
```
public void submit(java.lang.String newSearchXML)
            throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Submits the given search XML to the Intelligence Server. This will cause the search ID to be set to the search ID which results from this submission.
    
    Specified by:
    
    submit in interface WebSearch
    
    Parameters:
    
    newSearchXML - The search XML to be sent to the Intelligence Server. This overrides all properties on this WebSearch object.
    
    Throws:
    
    WebObjectsException - Thrown if the search could not be submitted to the Intelligence Server.
  - getStatus
```
public int getStatus()
```
    Description copied from interface: WebSearch
    
    Returns the status of the last getResults call which was made.
    
    Specified by:
    
    getStatus in interface WebSearch
    
    Returns:
    
    The status of the search, a value from EnumDSSXMLObjectSearchStatus.
  - getSearchID
```
public java.lang.String getSearchID()
```
    Description copied from interface: WebSearch
    
    Returns the search ID of the last search submitted by this object, or the last time setSearchID was called.
    
    Specified by:
    
    getSearchID in interface WebSearch
    
    Returns:
    
    The currently active search ID.
    
    See Also:
    
    WebSearch.setSearchID(java.lang.String)
  - setSearchID
```
public void setSearchID(java.lang.String _searchID)
```
    Description copied from interface: WebSearch
    
    Sets the search ID, which will be used when getResults is called.
    
    Specified by:
    
    setSearchID in interface WebSearch
    
    Parameters:
    
    _searchID - The search ID of a search which is executing or has results waiting on the Intelligence Server.
    
    See Also:
    
    WebSearch.getSearchID()
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: WebSearch
    
    Returns whether getResults will be asynchronous. If this is true, then getResults will poll the Intelligence Server once, and return, storing the status in the status property variable (obtainable via getStatus). If this is false, then the API will poll the Intelligence Server, using the polling frequency set by setPollingFrequency, and return only when either the result of the search is available or the max wait time (which can be set by setMaxWait) has been reached, at which point it will return without a result.
    
    Specified by:
    
    isAsync in interface WebSearch
    
    Returns:
    
    True if this object is asynchronous, false otherwise.
    
    See Also:
    
    WebSearch.setAsync(boolean)
  - setAsync
```
public void setAsync(boolean _async)
```
    Description copied from interface: WebSearch
    
    Sets whether getResults will be asynchronous. If this is true, then getResults will poll the Intelligence Server once, and return, storing the status in the status property variable (obtainable via getStatus). If this is false, then the API will poll the Intelligence Server, using the polling frequency set by setPollingFrequency, and return only when either the result of the search is available or the max wait time (which can be set by setMaxWait) has been reached, at which point it will return without a result.
    
    Specified by:
    
    setAsync in interface WebSearch
    
    Parameters:
    
    _async - The desired setting of [a]synchronous operation.
    
    See Also:
    
    WebSearch.isAsync()
  - getMaxWait
```
public int getMaxWait()
```
    Description copied from interface: WebSearch
    
    Returns the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
    
    Specified by:
    
    getMaxWait in interface WebSearch
    
    Returns:
    
    The maximum wait time, in milliseconds. If this value is -1, then getResults will not return unless the search finishes or an error is detected.
    
    See Also:
    
    WebSearch.setMaxWait(int)
  - setMaxWait
```
public void setMaxWait(int millis)
```
    Description copied from interface: WebSearch
    
    Sets the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
    
    Specified by:
    
    setMaxWait in interface WebSearch
    
    Parameters:
    
    millis - The maximum wait time, in milliseconds. If this value is -1, then getResults will not return unless the search finishes or an error is detected.
    
    See Also:
    
    WebSearch.getMaxWait()
  - getPollingFrequency
```
public int getPollingFrequency()
```
    Description copied from interface: WebSearch
    
    Returns the current polling frequency, in milliseconds. This determines, in synchronous mode, how often the API will poll the Intelligence Server upon calling getResults.
    
    Specified by:
    
    getPollingFrequency in interface WebSearch
    
    Returns:
    
    The current polling frequency, in milliseconds.
    
    See Also:
    
    WebSearch.setPollingFrequency(int)
  - setPollingFrequency
```
public void setPollingFrequency(int millis)
```
    Description copied from interface: WebSearch
    
    Sets the current polling frequency, in milliseconds. This determines, in synchronous mode, how often the API will poll the Intelligence Server upon calling getResults.
    
    Specified by:
    
    setPollingFrequency in interface WebSearch
    
    Parameters:
    
    millis - The desired polling frequency, in milliseconds.
    
    See Also:
    
    WebSearch.getPollingFrequency()
  - setDataSources
```
public void setDataSources(java.lang.String _dataSources)
```
    Specified by:
    
    setDataSources in interface WebObjectInfo
  - getResults
```
public WebFolder getResults()
                     throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Attempts to get the results of a search from the Intelligence Server. The search ID used will be the one set on this WebSearch object. If the asynchronous setting is true, then this method will return null and set the status variable if the report is not ready. If asynchronous is false, then this method will poll the Intelligence Server, subject to the parameters maxWait and pollingFrequency.
    
    Specified by:
    
    getResults in interface WebSearch
    
    Returns:
    
    A folder object representing the folder returned from the search, or null if the search is not yet ready.
    
    Throws:
    
    WebObjectsException - Signals an error in the execution or retrieval of results of the search.
  - getResults
```
public WebFolder getResults(boolean dereferenceShortcuts)
                     throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 8.0.1
  - purge
```
public void purge()
           throws WebObjectsException
```
    Description copied from interface: WebSearch
    
    Purges the search whose ID is set on this WebSearch object from the Intelligence Server's memory. This will free up resources dedicated to the given search.
    
    Specified by:
    
    purge in interface WebSearch
    
    Throws:
    
    WebObjectsException - Signals an error in purging the search.
  - reset
```
public void reset()
```
    Description copied from interface: WebSearch
    
    Resets all member variables on this object, which causes a reset of the search criteria.
    
    Specified by:
    
    reset in interface WebSearch
  - 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()
  - 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.
  - 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.
  - doFlatState
```
protected void doFlatState(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)
```
  - createSAXParser
```
protected com.microstrategy.web.objects.WebOISAXParser createSAXParser()
```
    Since:
    
    MicroStrategy Web 8.0.1
  - getSearchExcludeRoots
```
public java.util.List<WebFolder> getSearchExcludeRoots()
```
    Description copied from interface: WebSearch
    
    Returns the excluded folders for the search
    
    Specified by:
    
    getSearchExcludeRoots in interface WebSearch
  - isGettingTreeInfo
```
public boolean isGettingTreeInfo()
```
    Description copied from interface: WebSearch
    
    Gets the setting about whether the search result would include the browsing tree structure or not.
    
    Specified by:
    
    isGettingTreeInfo in interface WebSearch
    
    Returns:
    
    setting about whether the search result would include the browsing tree structure or not.
  - setGettingTreeInfo
```
public void setGettingTreeInfo(boolean gettingTreeInfo)
```
    Description copied from interface: WebSearch
    
    Sets the setting about whether the search result would include the browsing tree structure or not. When this sets it to true, user would be able to retrieve the search result in a tree structure by calling getChildrenInTree() on the return value from getResults() from this interface.
    
    Specified by:
    
    setGettingTreeInfo in interface WebSearch
  - isSynchronousQuickSearch
```
public boolean isSynchronousQuickSearch()
```
    Description copied from interface: WebSearch
    
    Gets the setting about whether the search should be handled by the Synchronous quick search engine.
    
    Specified by:
    
    isSynchronousQuickSearch in interface WebSearch
    
    Returns:
    
    setting about whether the search should be handled by the Synchronous quick search engine.
  - isQuickSearch
```
public boolean isQuickSearch()
```
    Description copied from interface: WebSearch
    
    Gets the setting about whether the search should be handled by the new quick search engine.
    
    Specified by:
    
    isQuickSearch in interface WebSearch
    
    Returns:
    
    setting about whether the search should be handled by the new quick search engine.
  - setQuickSearch
```
public void setQuickSearch(boolean quickSearch)
```
    Description copied from interface: WebSearch
    
    Sets the setting about whether the search should be handled by the new quick search engine. When this sets it to true, the search will be handled by the new quick search engine.
    
    Specified by:
    
    setQuickSearch in interface WebSearch
  - getSearchType
```
public int getSearchType()
```
    Description copied from interface: WebSearch
    
    Return current setting of Search Type
    
    Specified by:
    
    getSearchType in interface WebSearch
    
    Returns:
    
    int A value in EnumDSSXMLSearchTypes.
  - setSearchType
```
public void setSearchType(int searchType)
```
    Description copied from interface: WebSearch
    
    Sets the setting for the new quick search engine. Search Types are defined in EnumDSSXMLSearchTypes When this is not set, search reqeust will be redirected to old searc engine.
    
    Specified by:
    
    setSearchType in interface WebSearch
  - getSearchFields
```
public java.lang.String getSearchFields()
```
    Description copied from interface: WebSearch
    
    Return current setting of Search Fields
    
    Specified by:
    
    getSearchFields in interface WebSearch
    
    Returns:
    
    String
  - setSearchFields
```
public void setSearchFields(java.lang.String searchFields)
```
    Description copied from interface: WebSearch
    
    Sets the setting for the new quick search engine. Search Fields are combination of "name", "description" and "comment" separated by ",". When this is not set, search request will ask engine to use its default value - - Begin With - "name" - Exactly - "name" - Contains Any Word - "name,description,comment"
    
    Specified by:
    
    setSearchFields in interface WebSearch
  - setQuickSearchVisibility
```
public void setQuickSearchVisibility(EnumDSSXMLQuickSearchVisibility quickSearchVisibility)
```
    Description copied from interface: WebSearch
    
    Set the include hidden mode to be used for the quick search
    
    Specified by:
    
    setQuickSearchVisibility in interface WebSearch
  - getQuickSearchVisibility
```
public EnumDSSXMLQuickSearchVisibility getQuickSearchVisibility()
```
    Description copied from interface: WebSearch
    
    Get the include hidden mode to be used for the quick search
    
    Specified by:
    
    getQuickSearchVisibility in interface WebSearch
    
    Returns:
  - getQuickSearchCertifiedStatus
```
public EnumDSSXMLQuickSearchCertifiedStatus getQuickSearchCertifiedStatus()
```
    Description copied from interface: WebSearch
    
    Get the certified status criteria for the quick search
    
    Specified by:
    
    getQuickSearchCertifiedStatus in interface WebSearch
    
    Returns:
  - getQuickSearchDocumentTypes
```
public java.util.List<java.lang.Integer> getQuickSearchDocumentTypes()
```
    Description copied from interface: WebSearch
    
    Get a list of document types that the user wants to search for. Document type please see EnumDSSXMLViewMedia
    
    Specified by:
    
    getQuickSearchDocumentTypes in interface WebSearch
    
    Returns:
  - setQuickSearchDocumentTypes
```
public void setQuickSearchDocumentTypes(java.util.List<java.lang.Integer> types)
```
    Description copied from interface: WebSearch
    
    Set a list of document types that the user wants to search for. Passing a empty list, all document types will be returned.
    
    Specified by:
    
    setQuickSearchDocumentTypes in interface WebSearch
  - setQuickSearchCertifiedStatus
```
public void setQuickSearchCertifiedStatus(EnumDSSXMLQuickSearchCertifiedStatus quickSearchCertifiedStatus)
```
    Description copied from interface: WebSearch
    
    Set the certified status criteria to be used for the quick search
    
    Specified by:
    
    setQuickSearchCertifiedStatus in interface WebSearch
  - getQuickSearchEnabledStatus
```
public EnumDSSXMLQuickSearchEnabledStatus getQuickSearchEnabledStatus()
```
    Description copied from interface: WebSearch
    
    Get the user enabled status for quick search. Right now, only ENABLED_ONLY and ALL are supported.
    
    Specified by:
    
    getQuickSearchEnabledStatus in interface WebSearch
    
    Returns:
  - setQuickSearchEnabledStatus
```
public void setQuickSearchEnabledStatus(EnumDSSXMLQuickSearchEnabledStatus userEnabledStatus)
```
    Description copied from interface: WebSearch
    
    Set the user enabled status for quick search. By setting this field, the user can specify if they want to retrieve all the users matching either full name, username or email
    
    Specified by:
    
    setQuickSearchEnabledStatus in interface WebSearch
  - getQuickSearchMode
```
public EnumDSSXMLQuickSearchMode getQuickSearchMode()
```
    Description copied from interface: WebSearch
    
    Get the search mode for quick search. Only DEFAULT(0) and USER_MENTION(1) are supported. See EnumDSSXMLQuickSearchMode.
    
    Specified by:
    
    getQuickSearchMode in interface WebSearch
    
    Returns:
  - setQuickSearchMode
```
public void setQuickSearchMode(EnumDSSXMLQuickSearchMode quickSearchMode)
```
    Description copied from interface: WebSearch
    
    Set the search mode for quick search. Only DEFAULT(0) and USER_MENTION(1) are supported. DEFAULT will be used if this field was set with search mode other than DEFAULT(0) and USER_MENTION(1). See EnumDSSXMLQuickSearchMode.
    
    Specified by:
    
    setQuickSearchMode in interface WebSearch
  - getTargetUserGroupId
```
public java.lang.String getTargetUserGroupId()
```
    Description copied from interface: WebSearch
    
    Get the search target group id.
    
    Specified by:
    
    getTargetUserGroupId in interface WebSearch
    
    Returns:
    
    The search target group id.
  - setTargetUserGroupId
```
public void setTargetUserGroupId(java.lang.String targetUserGroupId)
```
    Description copied from interface: WebSearch
    
    Set the search target group id. By setting this field, it can specify the search result users if they are under this target group.
    
    Specified by:
    
    setTargetUserGroupId in interface WebSearch
  - 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)
  - getParent
```
public WebFolder getParent()
                    throws java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.
    
    Specified by:
    
    getParent in interface WebObjectInfo
    
    Returns:
    
    The parent folder of the current object. If this is the root folder, then this method will return null.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the parent could not be found or retrieved for the object.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from interface: WebDisplayUnit
    
    Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.
    
    Specified by:
    
    getDisplayName in interface WebDisplayUnit
    
    Returns:
    
    The display name associated with the display unit object.
    
    See Also:
    
    WebDisplayUnit.setDisplayName(java.lang.String), WebObjectInfo.getName()
  - setDisplayName
```
public void setDisplayName(java.lang.String _displayName)
```
    Description copied from interface: WebDisplayUnit
    
    This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.
    
    Specified by:
    
    setDisplayName in interface WebDisplayUnit
    
    Parameters:
    
    _displayName - The display name to associate with the object.
    
    See Also:
    
    WebDisplayUnit.getDisplayName(), WebObjectInfo.getName()
  - getNonSchedulable
```
public boolean getNonSchedulable()
```
    Description copied from interface: WebObjectInfo
    
    Get flag of whether the object is not schedulable
    
    Specified by:
    
    getNonSchedulable in interface WebObjectInfo
    
    Returns:
    
    whether the object is not schedulable
  - setNonSchedulable
```
public void setNonSchedulable(boolean non_schedulable)
```
    Description copied from interface: WebObjectInfo
    
    Set flag of whether the object is not schedulable
    
    Specified by:
    
    setNonSchedulable in interface WebObjectInfo
  - isAncestorNamedFolder
```
public boolean isAncestorNamedFolder(int folderName)
                              throws WebObjectsException,
                                     java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns whether the named folder is this object's ancestor.
    
    Specified by:
    
    isAncestorNamedFolder in interface WebObjectInfo
    
    Parameters:
    
    folderName - An Enumeration in EnumDSSXMLFolderNames
    
    Returns:
    
    true if the named folder in the ancestor list, false otherwise.
    
    Throws:
    
    WebObjectsException - Thrown if an error occurs in obtaining the DSSID for the named folder.
    
    java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.
  - isFeatureAvailable
```
public boolean isFeatureAvailable(java.lang.String feature)
```
    Description copied from interface: WebFeatures
    
    Returns whether the given feature is available or not.
    
    Specified by:
    
    isFeatureAvailable in interface WebFeatures
    
    Parameters:
    
    feature - The feature to check for, from EnumWebObjectsFeatures.
    
    Returns:
    
    Whether the given feature is available.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isFeatureAvailable
```
public boolean isFeatureAvailable(java.lang.String feature,
                                  java.lang.Object dependencyObject)
```
    Description copied from interface: WebFeatures
    
    Returns whether the given feature is available or not.
    
    Specified by:
    
    isFeatureAvailable in interface WebFeatures
    
    Parameters:
    
    feature - The feature to check for, from EnumWebObjectsFeatures.
    
    dependencyObject - A dependency object which can be used as an additional parameter for certain feature types.
    
    Returns:
    
    Whether the given feature is available.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getXMLForSave
```
protected java.lang.String getXMLForSave()
```
  - getXML
```
public java.lang.String getXML()
```
    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.
  - getExtParams
```
protected java.lang.String getExtParams()
```
  - performIncrFetchLocally
```
protected boolean performIncrFetchLocally()
```
    Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
    
    Returns:
    
    True if the incremental fetch should be performed on the Web Server Tier; otherwise, false.
    
    Since:
    
    MicroStrategy Web 8.0.2
  - isPopulated
```
public boolean isPopulated()
```
    Description copied from interface: WebObjectInfo
    
    Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
    
    Specified by:
    
    isPopulated in interface WebObjectInfo
    
    Returns:
    
    The current population status of this object.
  - getAncestors
```
public SimpleList getAncestors()
                        throws java.lang.UnsupportedOperationException
```
    Description copied from interface: WebObjectInfo
    
    Returns a SimpleList containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).
    
    Specified by:
    
    getAncestors in interface WebObjectInfo
    
    Returns:
    
    A SimpleList containing the ancestors of the object.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Thrown if the ancestors could not be found or retrieved for the object.
  - getSecurity
```
public WebObjectSecurity getSecurity()
```
    Description copied from interface: WebObjectInfo
    
    Returns the WebObjectSecurity object associated with this WebObjectInfo object. The WebObjectSecurity interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.
    
    Specified by:
    
    getSecurity in interface WebObjectInfo
    
    Returns:
    
    The WebObjectSecurity object associated with this WebObjectInfo object.
    
    Since:
    
    MicroStrategy Web 7.5.2
  - getDisplayUnitType
```
public int getDisplayUnitType()
```
    Description copied from interface: WebDisplayUnit
    
    Returns the type of display unit that this object represents. If this display unit represents a first-class object, then this method will return a value from EnumDSSXMLObjectTypes; otherwise, it will return a value from EnumWebDependentObjectType.
    
    Specified by:
    
    getDisplayUnitType in interface WebDisplayUnit
    
    Returns:
    
    The display unit type, from EnumDSSXMLObjectTypes or EnumWebDependentObjectType.
  - addDetails
```
public void addDetails(boolean details)
                throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.
    
    Specified by:
    
    addDetails in interface WebDisplayUnit
    
    Parameters:
    
    details - The desired state of details for the display unit.
    
    Throws:
    
    WebObjectsException - Thrown if the details cannot be retrieved from the Intelligence Server.
  - getDisplayXML
```
public java.lang.String getDisplayXML()
                               throws WebObjectsException
```
    Throws:
    
    WebObjectsException
  - equals
```
public boolean equals(WebObjectInfo otherOI)
```
  - postProcessOi
```
protected void postProcessOi(com.microstrategy.web.objects.WebObjectInfoImpl obj,
                             SAXSupport parser,
                             AttributesXt attrs)
                      throws org.xml.sax.SAXException
```
    Throws:
    
    org.xml.sax.SAXException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - handleOiBody
```
protected void handleOiBody(SAXSupport parser,
                            java.lang.String local,
                            org.xml.sax.Attributes attrs)
                     throws org.xml.sax.SAXException
```
    Throws:
    
    org.xml.sax.SAXException
  - handleOiEnd
```
protected void handleOiEnd(SAXSupport parser,
                           java.lang.String local,
                           java.lang.String buf)
```
  - isObjectInfo
```
public boolean isObjectInfo()
```
    Description copied from interface: WebDisplayUnit
    
    Returns true if underlying Web Object can be cast to WebObjectInfo. If an object can be cast to WebObjectInfo, then it is a first class object.
    
    Specified by:
    
    isObjectInfo in interface WebDisplayUnit
    
    Returns:
    
    true if underlying Web Object can be cast to WebObjectInfo.
  - buildShortXML
```
public void buildShortXML(WebXMLBuilder builder)
```
    Specified by:
    
    buildShortXML in interface WebObjectInfo
  - buildShortObjectAttributes
```
public void buildShortObjectAttributes(WebXMLBuilder builder)
```
    Specified by:
    
    buildShortObjectAttributes in interface WebObjectInfo
  - equals
```
public boolean equals(java.lang.Object otherObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setAbbreviation
```
public void setAbbreviation(java.lang.String ab)
```
    Specified by:
    
    setAbbreviation in interface WebObjectInfo
    
    Since:
    
    MicroStrategy Web 7.5.2
  - getFactory
```
public WebObjectsFactory getFactory()
```
    Description copied from interface: WebObjectInfo
    
    Returns WebObjectsFactory
    
    Specified by:
    
    getFactory in interface WebObjectInfo
    
    Returns:
    
    WebObjectsFactory
  - checkPrivilege
```
protected boolean checkPrivilege(java.lang.String feature)
                          throws WebObjectsException
```
    Throws:
    
    WebObjectsException
    
    Since:
    
    MicroStrategy Web 8.0.0
  - checkAccessRights
```
protected boolean checkAccessRights(java.lang.String feature)
```
    Since:
    
    MicroStrategy Web 8.0.0
  - checkAccessFlags
```
protected boolean checkAccessFlags(int flags)
```
    Since:
    
    MicroStrategy Web 8.0.0
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: WebObjectInfo
    
    Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.
    
    Specified by:
    
    isDirty in interface WebObjectInfo
    
    Returns:
    
    boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isNew
```
public boolean isNew()
```
    Description copied from interface: WebObjectInfo
    
    Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.
    
    Specified by:
    
    isNew in interface WebObjectInfo
    
    Returns:
    
    boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - isBodyDirty
```
protected boolean isBodyDirty()
```
    Since:
    
    MicroStrategy Web 8.0.0
  - 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)
```
  - getProjectId
```
public java.lang.String getProjectId()
```
    Specified by:
    
    getProjectId in interface WebObjectInfo
    
    Returns:
    
    project id of the object
  - getProjectName
```
public java.lang.String getProjectName()
```
    Specified by:
    
    getProjectName in interface WebObjectInfo
    
    Returns:
    
    project name of the object
  - getRecommendationInfo
```
public WebRecommendationInfo getRecommendationInfo()
```
    Description copied from interface: WebObjectInfo
    
    This contains all the information related to a recommendation search
    
    Specified by:
    
    getRecommendationInfo in interface WebObjectInfo
    
    Returns:
    
    recommendation info
  - setRecommendationInfo
```
public void setRecommendationInfo(WebRecommendationInfo recommendationInfo)
```
  - setProjectId
```
public void setProjectId(java.lang.String projectId)
```
  - getPreSaveAsFlags
```
public int getPreSaveAsFlags()
```
    Description copied from interface: WebObjectInfo
    
    Returns the flags which determine the previous save as prompt flag. This value is the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.
    
    Specified by:
    
    getPreSaveAsFlags in interface WebObjectInfo
    
    Returns:
    
    The previous set flags value.
    
    See Also:
    
    WebObjectInfo.setPreSaveAsFlags(int)
  - setPreSaveAsFlags
```
public void setPreSaveAsFlags(int flags)
```
    Description copied from interface: WebObjectInfo
    
    Sets the flags which determine the previous save as prompt flag. This value should be the integer or(|) of values from EnumDSSXMLDocSaveAsFlags.
    
    Specified by:
    
    setPreSaveAsFlags in interface WebObjectInfo
    
    Parameters:
    
    flags - The flags value to use for object definition retrieval.
    
    See Also:
    
    WebObjectInfo.getPreSaveAsFlags()
  - isHighlighted
```
public boolean isHighlighted()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this unit is highlighted.
    
    Specified by:
    
    isHighlighted in interface WebDisplayUnit
    
    Returns:
    
    True if the display unit is highlighted, false otherwise.
  - highlightUnit
```
public void highlightUnit()
```
    Description copied from interface: WebDisplayUnit
    
    Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.
    
    Specified by:
    
    highlightUnit in interface WebDisplayUnit
  - highlightUnit
```
public void highlightUnit(boolean details)
                   throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    Sets this display unit to be highlighted. The details value will determine whether it should include details as well.
    
    Specified by:
    
    highlightUnit in interface WebDisplayUnit
    
    Parameters:
    
    details - Whether the highlighted unit should include details.
    
    Throws:
    
    WebObjectsException - Thrown if the details for a highlighted unit cannot be retrieved from the Intelligence Server.
  - isSelected
```
public boolean isSelected()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this display unit is selected.
    
    Specified by:
    
    isSelected in interface WebDisplayUnit
    
    Returns:
    
    True if the unit is selected, false otherwise.
  - setSelected
```
public void setSelected(boolean selected)
```
    Description copied from interface: WebDisplayUnit
    
    Sets the current unit's selection status.
    
    Specified by:
    
    setSelected in interface WebDisplayUnit
    
    Parameters:
    
    selected - Whether the unit should be set to be selected or not.
  - _getObKey
```
public java.lang.Object _getObKey()
```
    Specified by:
    
    _getObKey in interface KeyedObject
    
    Since:
    
    MicroStrategy Web 8.0.0
  - getChildUnits
```
public WebDisplayUnits getChildUnits()
                              throws WebObjectsException
```
    Description copied from interface: WebDisplayUnit
    
    Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.
    
    Specified by:
    
    getChildUnits in interface WebDisplayUnit
    
    Returns:
    
    The collection of child display units of this instance, or null if this object is not a collection.
    
    Throws:
    
    WebObjectsException
  - getSelectedCount
```
public int getSelectedCount()
                     throws WebObjectsException
```
    Throws:
    
    WebObjectsException
  - hasDetails
```
public boolean hasDetails()
```
    Description copied from interface: WebDisplayUnit
    
    Returns whether this display unit currently has details enabled.
    
    Specified by:
    
    hasDetails in interface WebDisplayUnit
    
    Returns:
    
    True if details are enabled, false otherwise.
  - applyVisitor
```
public void applyVisitor(DisplayUnitsVisitor visitor,
                         boolean deep)
                  throws WebObjectsException
```
    Specified by:
    
    applyVisitor in interface WebDisplayUnit
    
    Throws:
    
    WebObjectsException
  - canHighlight
```
public boolean canHighlight()
```
    Specified by:
    
    canHighlight in interface WebDisplayUnit
    
    Since:
    
    MicroStrategy Web 8.0.0
  - saveXMLState
```
protected void saveXMLState(java.lang.StringBuffer buf,
                            int howMuchState)
```
    Overrides:
    
    saveXMLState in class AbstractPersistable
  - saveXMLState
```
protected void saveXMLState(WebXMLBuilder builder,
                            int howMuchState)
```

Class WebChangeJournalSearchImpl

Field Summary

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

Fields inherited from interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.utils.KeyedObject

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

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

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

Constructor Detail

WebChangeJournalSearchImpl

Method Detail

setUsers

setMachines

setSessions

setAffectedObjects

setAffectedProjects

setTransactionTypes

setChangeTypes

setApplicationTypes

setBeginTime

getBeginTime

setEndTime

getEndTime

setBeginTransactionID

getBeginTransactionID

setEndTransactionID

getEndTransactionID

submit

getChangeJournalResults

getAbbreviationPattern

setAbbreviationPattern

getAccessRights

setAccessRights

getBlockBegin

setBlockBegin

getBlockCount

setBlockCount

getDescriptionPattern

setDescriptionPattern

getDomain

setDomain

getScope

setScope

getSearchFlags

setSearchFlags

getMaxObjects

setMaxObjects

getOutputType

setOutputType

getFirstObjectIndex

setFirstObjectIndex

getNamePattern

setNamePattern

getSearchOwner

setSearchOwner

getSearchRoot

setSearchRoot

getStateClear

setStateClear

getStateSet

setStateSet

setCreatedModifiedByDate

setCreatedModifiedByDate

setCreatedModifiedByInterval

types

usedBy

usedBy

notUsedBy

uses

uses

notUses