Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

public interface

WebChangeJournalSearch

implements WebSearch

com.microstrategy.web.objects.WebChangeJournalSearch

Known Indirect Subclasses

WebChangeJournalSearchImpl

Class Overview

The WebChangeJournalSearch class represents a change journal search object It allows the user specify the restrictions of the search, including users, machines and so on. And submit searches to the Intelligence Server.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

Public Methods
abstract WebChangeJournalEntries	getChangeJournalResults() Attempts to get the change journal results of a search from the Intelligence Server.
abstract void	setAffectedObjects(List<WebObjectInfo> objects) Set the restriction about affected objects for the change journal entries that the search returns.
abstract void	setAffectedProjects(List<WebObjectInfo> projects) Set the restriction about affected projects for the change journal entries that the search returns.
abstract void	setApplicationTypes(List<Integer> applicationTypes) Set the restriction about application types for the change journal entries that the search returns.
abstract void	setBeginTime(String beginTime) Set the begin time value for the change journal entries that the search returns.
abstract void	setBeginTransactionID(String transactionID) Set the begin transaction id value for the change journal entries that the search returns.
abstract void	setChangeTypes(List<Integer> changeTypes) Set the restriction about transaction types for the change journal entries that the search returns.
abstract void	setEndTime(String endTime) Set the end time value for the change journal entries that the search returns.
abstract void	setEndTransactionID(String transactionID) Set the end transaction id value for the change journal entries that the search returns.
abstract void	setMachines(List<String> machines) Set the restriction about machines for the change journal entries that the search returns.
abstract void	setSessions(List<String> sessions) Set the restriction about sessions for the change journal entries that the search returns.
abstract void	setTransactionTypes(List<Integer> transactionTypes) Set the restriction about transaction types for the change journal entries that the search returns.
abstract void	setUsers(List<WebObjectInfo> users) Set the restriction about users for the change journal entries that the search returns.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.KeyedObject

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.objects.WebDisplayUnit

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

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

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

From interface com.microstrategy.web.objects.WebPromptSite

From interface com.microstrategy.web.objects.WebSearch

abstract WebFolder	doSynchronousQuickSearch() Do the Synchronous Quick Search
abstract String	getAbbreviationPattern() Gets the abbreviation pattern that the Search object will search for.
abstract int	getAccessRights() Returns the access rights of the object being searched for, that the search will be narrowed by.
abstract int	getBlockBegin() Returns the blockBegin value for the objects that the search returns.
abstract int	getBlockCount() Returns the blockCount value for the objects that the search returns.
abstract String	getDescriptionPattern() Returns the description pattern that the search is currently limited to.
abstract int	getDomain() Returns the current domain for the search.
abstract int	getFirstObjectIndex() Returns the index to begin searching from.
abstract int	getMaxObjects() Returns the maximum number of objects the search is configured to return.
abstract int	getMaxWait() Returns the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
abstract String	getNamePattern() Returns the pattern to search for in the name of the objects in metadata.
abstract int	getPollingFrequency() Returns the current polling frequency, in milliseconds.
abstract WebFolder	getResults() Attempts to get the results of a search from the Intelligence Server.
abstract int	getScope() Returns the current scope for the search.
abstract List<WebFolder>	getSearchExcludeRoots() Returns the excluded folders for the search
abstract String	getSearchFields() Return current setting of Search Fields
abstract int	getSearchFlags() Returns the currently set search flags.
abstract String	getSearchID() Returns the search ID of the last search submitted by this object, or the last time setSearchID was called.
abstract String	getSearchOwner() Returns the value of the search owner restriction on the search, if it is currently set.
abstract String	getSearchRoot() Returns the root folder ID that the search is limited to, if applicable.
abstract int	getSearchType() Return current setting of Search Type
abstract int	getStateClear() Returns the object states that the search is prohibited from returning.
abstract int	getStateSet() Returns the object states that the search will be limited to.
abstract int	getStatus() Returns the status of the last getResults call which was made.
abstract boolean	isAsync() Returns whether getResults will be asynchronous.
abstract boolean	isGettingTreeInfo() Gets the setting about whether the search result would include the browsing tree structure or not.
abstract boolean	isQuickSearch() Gets the setting about whether the search should be handled by the new quick search engine.
abstract boolean	isSynchronousQuickSearch() Gets the setting about whether the search should be handled by the Synchronous quick search engine.
abstract void	notUsedBy(int type) The resulting objects of the search is NOT used by objects of the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
abstract void	notUses(int type) The resulting objects of the search does NOT use the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
abstract void	purge() Purges the search whose ID is set on this WebSearch object from the Intelligence Server's memory.
abstract void	reset() Resets all member variables on this object, which causes a reset of the search criteria.
abstract void	setAbbreviationPattern(String abbreviationPattern) Sets the abbreviation pattern of objects that a search will return.
abstract void	setAccessRights(int accessRights) This will set the access rights that the search results will be limited by.
abstract void	setAsync(boolean async) Sets whether getResults will be asynchronous.
abstract void	setBlockBegin(int blockBegin) Sets the blockBegin value for the objects that the search returns.
abstract void	setBlockCount(int blockCount) Sets the blockCount value for the objects that the search returns.
abstract void	setCreatedModifiedByDate(Date beginTime, Date endTime) Sets the created/modified by date range of the search criteria.
abstract void	setCreatedModifiedByDate(String beginTime, String endTime) Sets the created/modified by date range of the search criteria.
abstract void	setCreatedModifiedByInterval(int timeInterval, int intervalUnit) Sets the interval for the created/modified by time for the search.
abstract void	setDescriptionPattern(String descriptionPattern) Sets the description pattern that the search will be limited to.
abstract void	setDomain(int domain) Sets the domain that the search will be limited to.
abstract void	setFirstObjectIndex(int firstObjectIndex) Sets the index to begin searching from.
abstract void	setGettingTreeInfo(boolean gettingTreeInfo) Sets the setting about whether the search result would include the browsing tree structure or not.
abstract void	setMaxObjects(int maxObjects) Sets the maximum number of objects that the search will return.
abstract void	setMaxWait(int millis) Sets the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.
abstract void	setNamePattern(String namePattern) Sets the pattern to search for in the name of the objects in metadata.
abstract void	setPollingFrequency(int millis) Sets the current polling frequency, in milliseconds.
abstract void	setQuickSearch(boolean quickSearch) Sets the setting about whether the search should be handled by the new quick search engine.
abstract void	setScope(int scope) Sets the scope that the search will be limited to.
abstract void	setSearchFields(String searchFields) Sets the setting for the new quick search engine.
abstract void	setSearchFlags(int flags) Sets the search flags for the search.
abstract void	setSearchID(String searchID) Sets the search ID, which will be used when getResults is called.
abstract void	setSearchOwner(String searchOwner) Sets the value of the owner restriction on the search.
abstract void	setSearchRoot(String searchRoot) Sets the root folder that the search will be limited to.
abstract void	setSearchType(int searchType) Sets the setting for the new quick search engine.
abstract void	setStateClear(int stateClear) Sets the object states that the search is prohibited from returning.
abstract void	setStateSet(int stateSet) Sets the object states that should be returned in the search.
abstract void	submit() Submits the current state of this search object to the Intelligence Server.
abstract void	submit(String searchXML) Submits the given search XML to the Intelligence Server.
abstract SimpleList	types() Returns a `SimpleList` from which types can be added or removed.
abstract void	usedBy(int type) The resulting objects of the search is used by objects of the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).
abstract 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).
abstract 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).
abstract void	uses(int type) The resulting objects of the search uses the specified type (`EnumDSSXMLObjectTypes`) or subtype (`EnumDSSXMLObjectSubTypes`).

Public Methods

public abstract WebChangeJournalEntries getChangeJournalResults ()

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.

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.

public abstract void setAffectedObjects (List<WebObjectInfo> objects)

Set the restriction about affected objects for the change journal entries that the search returns.

public abstract void setAffectedProjects (List<WebObjectInfo> projects)

Set the restriction about affected projects for the change journal entries that the search returns.

public abstract void setApplicationTypes (List<Integer> applicationTypes)

Set the restriction about application types for the change journal entries that the search returns.

public abstract void setBeginTime (String beginTime)

Set the begin time value for the change journal entries that the search returns.

public abstract void setBeginTransactionID (String transactionID)

Set the begin transaction id value for the change journal entries that the search returns.

public abstract void setChangeTypes (List<Integer> changeTypes)

Set the restriction about transaction types for the change journal entries that the search returns.

public abstract void setEndTime (String endTime)

Set the end time value for the change journal entries that the search returns.

public abstract void setEndTransactionID (String transactionID)

Set the end transaction id value for the change journal entries that the search returns.

public abstract void setMachines (List<String> machines)

Set the restriction about machines for the change journal entries that the search returns.

public abstract void setSessions (List<String> sessions)

Set the restriction about sessions for the change journal entries that the search returns.

public abstract void setTransactionTypes (List<Integer> transactionTypes)