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

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebObjectsFeatures
From interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags
Public Constructors
WebChangeJournalSearchImpl(WebObjectsFactory _factory)
Public Methods
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()
WebFolder doSynchronousQuickSearch()
Do the Synchronous Quick Search
boolean equals(Object otherObject)
boolean equals(WebObjectInfo otherOI)
String getAbbreviation()
Returns the abbreviation of this object.
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.
String getBeginTime()
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.
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.
String[] getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
String getContainerDid()
String getContainerType()
String getCreationTime()
Returns the creation time of this object, if that information is available.
String getDataSources()
String getDescription()
Returns the description of the object.
String getDescriptionPattern()
Returns the description pattern that the search is currently limited to.
String getDisplayName()
Returns the display name associated with this object.
int getDisplayUnitType()
Returns the type of display unit that this object represents.
String getDisplayXML()
int getDomain()
Returns the current domain for the search.
String getEndTime()
String getEndTransactionID()
int getExtendedType()
The current extended type
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.
String getID()
Returns the DSS ID of the object, if one exists.
String getIconPath()
Return the icon path for the object
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.
String getModificationTime()
Returns the last modification time of the object, if that information is available.
long getModificationTimeStamp()
String getName()
Returns the name of this object.
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.
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.
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.
List<WebFolder> getSearchExcludeRoots()
Returns the excluded folders for the search
String getSearchFields()
Return current setting of Search Fields
int getSearchFlags()
Returns the currently set search flags.
String getSearchID()
Returns the search ID of the last search submitted by this object, or the last time setSearchID was called.
String getSearchOwner()
Returns the value of the search owner restriction on the search, if it is currently set.
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.
int getType()
Returns the type of this object.
String getVersionID()
Returns the Version ID of the object, if one exists.
WebViewMediaSettings getViewMediaSettings()
int getVisualizationViewMode()
String getXML(boolean encode)
Returns the XML representation of this object.
String getXML()
Returns the XML representation of this object.
boolean hasDetails()
Returns whether this display unit currently has details enabled.
boolean hasOwner()
int hashCode()
void highlightUnit(boolean details)
Sets this display unit to be highlighted.
void highlightUnit()
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.
boolean isDirty()
Returns whether this object has been modified to be different from the object in metadata.
boolean isEmbedded()
boolean isFeatureAvailable(String feature)
Returns whether the given feature is available or not.
boolean isFeatureAvailable(String feature, 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).
void populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.
void populate(String xml)
Populates the fields on this object by loading the given object definition XML.
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.
void setAbbreviation(String ab)
void setAbbreviationPattern(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(List<WebObjectInfo> _affectedObjects)
Set the restriction about affected objects for the change journal entries that the search returns.
void setAffectedProjects(List<WebObjectInfo> _affectedProjects)
Set the restriction about affected projects for the change journal entries that the search returns.
void setApplicationTypes(List<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(String _beginTime)
Set the begin time value for the change journal entries that the search returns.
void setBeginTransactionID(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 setChangeTypes(List<Integer> _changeTypes)
Set the restriction about transaction types for the change journal entries that the search returns.
void setComments(String[] _comments)
Set the long description of the object as an array of strings.
void setCreatedModifiedByDate(Date _beginTime, Date _endTime)
Sets the created/modified by date range of the search criteria.
void setCreatedModifiedByDate(String _beginTime, String _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(String _dataSources)
void setDescription(String _description)
Sets the description of the object.
void setDescriptionPattern(String _descriptionPattern)
Sets the description pattern that the search will be limited to.
void setDisplayName(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(String _endTime)
Set the end time value for the change journal entries that the search returns.
void setEndTransactionID(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(String iconPath)
Set the icon path for the object
void setMachines(List<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(String _name)
void setNamePattern(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 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 setScope(int _scope)
Sets the scope that the search will be limited to.
void setSearchFields(String searchFields)
Sets the setting for the new quick search engine.
void setSearchFlags(int _searchFlags)
Sets the search flags for the search.
void setSearchID(String _searchID)
Sets the search ID, which will be used when getResults is called.
void setSearchOwner(String _searchOwner)
Sets the value of the owner restriction on the search.
void setSearchRoot(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(List<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 setTransactionTypes(List<Integer> _transactionTypes)
Set the restriction about transaction types for the change journal entries that the search returns.
void setUsers(List<WebObjectInfo> _users)
Set the restriction about users for the change journal entries that the search returns.
void submit(String newSearchXML)
Submits the given search XML to the Intelligence Server.
void submit()
Submits the current state of this search object to the Intelligence Server.
String toString()
SimpleList types()
Returns a SimpleList from which types can be added or removed.
void usedBy(int type)
The resulting objects of the search is used by objects of the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).
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).
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).
Protected Methods
boolean checkAccessFlags(int flags)
boolean checkAccessRights(String feature)
boolean checkPrivilege(String feature)
WebOIDOMHandler createDOMHandler()
WebOIDisplayXMLHandler createDisplayXMLHandler()
WebOISAXParser createSAXParser()
WebOIXMLBuilder createXMLBuilder()
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
String getExtParams()
String getXMLForSave()
void handleOiBody(SAXSupport parser, String local, Attributes attrs)
void handleOiEnd(SAXSupport parser, String local, String buf)
boolean isBodyDirty()
boolean performIncrFetchLocally()
Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
void postProcessOi(WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebChangeJournalSearch
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite
From interface com.microstrategy.web.objects.WebSearch

Public Constructors

public WebChangeJournalSearchImpl (WebObjectsFactory _factory)

Public Methods

public Object _getObKey ()

public void addDetails (boolean details)

This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.

Parameters
details The desired state of details for the display unit.
Throws
WebObjectsException

public void applyVisitor (DisplayUnitsVisitor visitor, boolean deep)

Throws
WebObjectsException

public void buildShortObjectAttributes (WebXMLBuilder builder)

public void buildShortXML (WebXMLBuilder builder)

public boolean canHighlight ()

public WebFolder doSynchronousQuickSearch ()

Do the Synchronous Quick Search

Returns
  • A folder object representing the folder returned from the search, or null if the search is not yet ready.
Throws
WebObjectsException

public boolean equals (Object otherObject)

public boolean equals (WebObjectInfo otherOI)

public String getAbbreviation ()

Returns the abbreviation of this object.

Returns
  • The object's abbreviation, if one exists.

public String getAbbreviationPattern ()

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.

Returns
  • The abbreviation pattern to search for.

public int getAccessGranted ()

Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.

Returns
  • The numeric representation of the access this user has to the object.

public int getAccessRights ()

Returns the access rights of the object being searched for, that the search will be narrowed by. This value corresponds to those in EnumDSSXMLAccessRightFlags.

Returns
  • An int corresponding to the access rights that the search will be filtered on.

public SimpleList getAncestors ()

Returns a SimpleList containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).

Returns
  • A SimpleList containing the ancestors of the object.
Throws
UnsupportedOperationException

public String getBeginTime ()

public String getBeginTransactionID ()

public int getBlockBegin ()

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.

Returns
  • The current setting for the first element to return from the search.

public int getBlockCount ()

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.

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.

public 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

public WebDisplayUnits getChildUnits ()

Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.

Returns
  • The collection of child display units of this instance, or null if this object is not a collection.
Throws
WebObjectsException

public String[] getComments ()

Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object. These comments can be set programmatically or using MicroStrategy Desktop (Properties editor -> Long description tab) and are separated by a carriage return.

Returns
  • String array of comments

public String getContainerDid ()

public String getContainerType ()

public String getCreationTime ()

Returns the creation time of this object, if that information is available.

Returns
  • A string representing the creation time of this object.

public String getDataSources ()

public String getDescription ()

Returns the description of the object.

Returns
  • The current description of this object.

public String getDescriptionPattern ()

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.

Returns
  • The current description pattern to search for.

public String getDisplayName ()

Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.

Returns
  • The display name associated with the display unit object.

public int getDisplayUnitType ()

Returns the type of display unit that this object represents. If this display unit represents a first-class object, then this method will return a value from EnumDSSXMLObjectTypes; otherwise, it will return a value from EnumWebDependentObjectType.

Returns

public String getDisplayXML ()

Throws
WebObjectsException

public int getDomain ()

Returns the current domain for the search. The domain tells the scope in which the search will be performed.

The default domain is DssXmlSearchDomainProject.

Returns

public String getEndTime ()

public String getEndTransactionID ()

public int getExtendedType ()

The current extended type

Returns

public WebObjectsFactory getFactory ()

Returns WebObjectsFactory

Returns
  • WebObjectsFactory

public int getFirstObjectIndex ()

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.

Returns
  • The index to begin searching from.

public int getFlags ()

Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Returns
  • The currently set flags value.

public String getID ()

Returns the DSS ID of the object, if one exists.

Returns
  • A String representing the ID of the object.

public String getIconPath ()

Return the icon path for the object

Returns
  • String containing the icon path for the object

public int getMaxObjects ()

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.

Returns
  • The maximum number of objects a search will return.

public int getMaxWait ()

Returns the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.

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.

public String getModificationTime ()

Returns the last modification time of the object, if that information is available.

Returns
  • A string representing the last modification time of the object.

public long getModificationTimeStamp ()

public String getName ()

Returns the name of this object. the name retrieved with this method is read-only on this interface, comes from the MetaData name of a first-class object. If you wish to change the name displayed to the screen, setDisplayName(String) should be used along with the getDisplayName() call. Please also note that while only first-class objects (i.e. WebObjectInfo) has a "name" property, many object types (WebElements, and WebDimtyUnit) can have their respective "names" accessed or changed on the screen via getDisplayName() and setDisplayName(String). If you want to change the object's actual metadata name, it can be done via the appropriate save(WebObjectInfo, String) or save(WebObjectInfo, String, WebFolder) calls.

Returns
  • The name of the object.

public String getNamePattern ()

Returns the pattern to search for in the name of the objects in metadata.

Returns
  • The name pattern that will be searched for.

public boolean getNonSchedulable ()

Get flag of whether the object is not schedulable

Returns
  • whether the object is not schedulable

public int getOtherNameTransCount ()

Returns the count of name translations for locales other than the current effective locale.

Returns
  • The count of name translations for locales other than the current effective locale.

public int getOutputType ()

public WebObjectInfo getOwner ()

Returns a WebObjectInfo object which corresponds to the owner of this object.

Returns
  • A WebObjectInfo object, representing the owner of this object
Throws
WebObjectsException

public WebFolder getParent ()

Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.

Returns
  • The parent folder of the current object. If this is the root folder, then this method will return null.
Throws
UnsupportedOperationException

public int getPollingFrequency ()

Returns the current polling frequency, in milliseconds. This determines, in synchronous mode, how often the API will poll the Intelligence Server upon calling getResults.

Returns
  • The current polling frequency, in milliseconds.

public WebPromptInstances getPromptInstances ()

Returns a collection of prompt instances from this prompt site.

Returns
  • a collection of prompt instances.

public int getPropertyFlags ()

Retrieve the current property flags

Returns

public SimpleList getPropertySetFilter ()

Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets

public WebPropertyGroup getPropertySets ()

Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.

Returns
  • A WebPropertyGroup object, which contains the property sets associated with this object.
Throws
WebObjectsException

public WebFolder getResults ()

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.

Returns
  • A folder object representing the folder returned from the search, or null if the search is not yet ready.
Throws
WebObjectsException

public WebFolder getResults (boolean dereferenceShortcuts)

Throws
WebObjectsException

public int getScope ()

Returns the current scope for the search.

The default scope is DssXmlSearchScopeRootedObjects.

Returns

public List<WebFolder> getSearchExcludeRoots ()

Returns the excluded folders for the search

public String getSearchFields ()

Return current setting of Search Fields

Returns
  • String

public int getSearchFlags ()

Returns the currently set search flags.

The default value of the search flags is 0.

Returns

public String getSearchID ()

Returns the search ID of the last search submitted by this object, or the last time setSearchID was called.

Returns
  • The currently active search ID.

public String getSearchOwner ()

Returns the value of the search owner restriction on the search, if it is currently set.

Returns
  • The user whose objects the search is limited to.

public String getSearchRoot ()

Returns the root folder ID that the search is limited to, if applicable.

Returns
  • The folder ID that is to be used as the root of the search.

public int getSearchType ()

Return current setting of Search Type

Returns

public WebObjectSecurity getSecurity ()

Returns the WebObjectSecurity object associated with this WebObjectInfo object. The WebObjectSecurity interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.

Returns

public int getSelectedCount ()

Throws
WebObjectsException

public int getState ()

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

Returns
  • The state of this object.

public int getStateClear ()

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.

Returns
  • The current value for the clear states.

public int getStateSet ()

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.

Returns
  • The current value for the set states.

public int getStatus ()

Returns the status of the last getResults call which was made.

Returns

public int getSubType ()

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

Returns
  • The subtype of the object.

public int getType ()

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

Returns
  • The type of the object.

public String getVersionID ()

Returns the Version ID of the object, if one exists.

Returns
  • A String representing the ID of the object version.

public WebViewMediaSettings getViewMediaSettings ()

public int getVisualizationViewMode ()

public String getXML (boolean encode)

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell. The encoding parameter will tell whether the XML generated should have special characters HTML encoded.

Parameters
encode If this is true, then the returned string will have all special characters HTML-encoded.
Returns
  • The XML representation of the current state of this object.

public String getXML ()

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.

Returns
  • The XML representation of the current state of this object.

public boolean hasDetails ()

Returns whether this display unit currently has details enabled.

Returns
  • True if details are enabled, false otherwise.

public boolean hasOwner ()

public int hashCode ()

public void highlightUnit (boolean details)

Sets this display unit to be highlighted. The details value will determine whether it should include details as well.

Parameters
details Whether the highlighted unit should include details.
Throws
WebObjectsException

public void highlightUnit ()

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

public boolean isAncestorNamedFolder (int folderName)

Returns whether the named folder is this object's ancestor.

Parameters
folderName An Enumeration in EnumDSSXMLFolderNames
Returns
  • true if the named folder in the ancestor list, false otherwise.
Throws
WebObjectsException
UnsupportedOperationException

public boolean isAsync ()

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.

Returns
  • True if this object is asynchronous, false otherwise.

public boolean isDirty ()

Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.

Returns
  • boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.

public boolean isEmbedded ()

public boolean isFeatureAvailable (String feature)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
Returns
  • Whether the given feature is available.

public boolean isFeatureAvailable (String feature, Object dependencyObject)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
dependencyObject A dependency object which can be used as an additional parameter for certain feature types.
Returns
  • Whether the given feature is available.

public boolean isGettingTreeInfo ()

Gets the setting about whether the search result would include the browsing tree structure or not.

Returns
  • setting about whether the search result would include the browsing tree structure or not.

public boolean isHidden ()

Returns whether the object is a hidden object.

Returns
  • True if the object is a hidden object in metadata, false if it is not.

public boolean isHighlighted ()

Returns whether this unit is highlighted.

Returns
  • True if the display unit is highlighted, false otherwise.

public boolean isNew ()

Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.

Returns
  • boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.

public boolean isObjectInfo ()

Returns true if underlying Web Object can be cast to WebObjectInfo. If an object can be cast to WebObjectInfo, then it is a first class object.

Returns

public boolean isPopulated ()

Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.

Returns
  • The current population status of this object.

public boolean isQuickSearch ()

Gets the setting about whether the search should be handled by the new quick search engine.

Returns
  • setting about whether the search should be handled by the new quick search engine.

public boolean isSelected ()

Returns whether this display unit is selected.

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

public boolean isSynchronousQuickSearch ()

Gets the setting about whether the search should be handled by the Synchronous quick search engine.

Returns
  • setting about whether the search should be handled by the Synchronous quick search engine.

public void notUsedBy (int type)

The resulting objects of the search is NOT used by objects of the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

Parameters
type specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

public void notUses (int type)

The resulting objects of the search does NOT use the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

Parameters
type specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

public void populate ()

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

Throws
WebObjectsException

public void populate (String xml)

Populates the fields on this object by loading the given object definition XML.

Parameters
xml The XML String to use to populate this object.
Throws
WebObjectsException

public void purge ()

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.

Throws
WebObjectsException

public void reset ()

Resets all member variables on this object, which causes a reset of the search criteria.

public void setAbbreviation (String ab)

public void setAbbreviationPattern (String _abbreviationPattern)

Sets the abbreviation pattern of objects that a search will return.

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.

public void setAccessRights (int _accessRights)

This will set the access rights that the search results will be limited by.

Parameters
_accessRights The value to search for. This is the bitwise OR of values from EnumDSSXMLAccessRightFlags.

public void setAffectedObjects (List<WebObjectInfo> _affectedObjects)

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

public void setAffectedProjects (List<WebObjectInfo> _affectedProjects)

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

public void setApplicationTypes (List<Integer> _applicationTypes)

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

public void setAsync (boolean _async)

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.

Parameters
_async The desired setting of [a]synchronous operation.

public void setBeginTime (String _beginTime)

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

public void setBeginTransactionID (String _transactionID)

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

public void setBlockBegin (int _blockBegin)

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.

Parameters
_blockBegin The first element in the result list that should be returned from the search.

public void setBlockCount (int _blockCount)

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.

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.

public void setChangeTypes (List<Integer> _changeTypes)

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

public void setComments (String[] _comments)

Set the long description of the object as an array of strings. The long description is also known as the comments.

Parameters
_comments String array of comments

public void setCreatedModifiedByDate (Date _beginTime, Date _endTime)

Sets the created/modified by date range of the search criteria.

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
IllegalArgumentException

public void setCreatedModifiedByDate (String _beginTime, String _endTime)

Sets the created/modified by date range of the search criteria.

Parameters
_beginTime A string representing the beginning date of the range.
_endTime A string representing the ending date of the range.
Throws
IllegalArgumentException

public void setCreatedModifiedByInterval (int _timeInterval, int _intervalUnit)

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.

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.

public void setDataSources (String _dataSources)

public void setDescription (String _description)

Sets the description of the object. The object must be saved by the save or copy methods on the WebObjectSource object to cause a change to this object to be saved.

Parameters
_description The description for the object.

public void setDescriptionPattern (String _descriptionPattern)

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.

Parameters
_descriptionPattern The description pattern to use in the search.

public void setDisplayName (String _displayName)

This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.

Parameters
_displayName The display name to associate with the object.

public void setDomain (int _domain)

Sets the domain that the search will be limited to. By default, the domain is DssXmlSearchDomainProject.

Parameters
_domain The new value for the domain, coming from the EnumDSSXMLSearchDomain enumeration.

public void setEndTime (String _endTime)

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

public void setEndTransactionID (String _transactionID)

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

public void setExtendedType (int extendedType)

Set the current extended type

public void setFirstObjectIndex (int _firstObjectIndex)

Sets the index to begin searching from. Default is 1, meaning search from beginning.

Parameters
_firstObjectIndex The index to begin searching from.

public void setFlags (int _flags)

Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.

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

public void setGettingTreeInfo (boolean gettingTreeInfo)

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.

public void setHidden (boolean hid)

Sets whether the object is a hidden object. To save the change of this property to metadata, DssXmlObjectBrowser flag need to be set on WebObjectSource before calling save(WebObjectInfo) with this object as input parameter.

Parameters
hid boolean true to set this object to hidden.

public void setIconPath (String iconPath)

Set the icon path for the object

public void setMachines (List<String> _machines)

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

public void setMaxObjects (int _maxObjects)

Sets the maximum number of objects that the search will return. Default is -1, meaning return all objects.

Parameters
_maxObjects The maximum number of objects to return from the search.

public void setMaxWait (int millis)

Sets the maximum amount of time, in milliseconds, to wait for a search to finish in synchronous mode.

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.

public void setName (String _name)

public void setNamePattern (String _namePattern)

Sets the pattern to search for in the name of the objects in metadata.

Parameters
_namePattern The name pattern that will be searched for.

public void setNonSchedulable (boolean non_schedulable)

Set flag of whether the object is not schedulable

public void setOutputType (int _outputType)

public void setPollingFrequency (int millis)

Sets the current polling frequency, in milliseconds. This determines, in synchronous mode, how often the API will poll the Intelligence Server upon calling getResults.

Parameters
millis The desired polling frequency, in milliseconds.

public void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags

public void setQuickSearch (boolean quickSearch)

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.

public void setScope (int _scope)

Sets the scope that the search will be limited to. By default, scope is DssXmlSearchScopeRootedObjects.

Parameters
_scope domain The new value for the scope, coming from the EnumDSSXMLSearchScope enumeration.

public void setSearchFields (String searchFields)

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"

public void setSearchFlags (int _searchFlags)

Sets the search flags for the search.

Parameters
_searchFlags A value corresponding to a bitwise OR from the enumeration class EnumDSSXMLSearchFlags.

public void setSearchID (String _searchID)

Sets the search ID, which will be used when getResults is called.

Parameters
_searchID The search ID of a search which is executing or has results waiting on the Intelligence Server.

public void setSearchOwner (String _searchOwner)

Sets the value of the owner restriction on the search.

Parameters
_searchOwner The user whose objects the search is limited to.

public void setSearchRoot (String _searchRoot)

Sets the root folder that the search will be limited to. Requires an object ID corresponding to a folder.

Parameters
_searchRoot The folder ID of a folder that will be used as the root of the search.

public void setSearchType (int searchType)

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.

public void setSelected (boolean selected)

Sets the current unit's selection status.

Parameters
selected Whether the unit should be set to be selected or not.

public void setSessions (List<String> _sessions)

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

public void setStateClear (int _stateClear)

Sets the object states that the search is prohibited from returning.

Parameters
_stateClear An int corresponding to the bitwise OR of values from EnumDSSXMLObjectState. These states will not be in the search result set.

public void setStateSet (int _stateSet)

Sets the object states that should be returned in the search.

Parameters
_stateSet An int corresponding to the bitwise OR of values from EnumDSSXMLObjectState. Only objects with these states will be in the search result.

public void setTransactionTypes (List<Integer> _transactionTypes)

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

public void setUsers (List<WebObjectInfo> _users)

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

public void submit (String newSearchXML)

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.

Parameters
newSearchXML The search XML to be sent to the Intelligence Server. This overrides all properties on this WebSearch object.
Throws
WebObjectsException

public void submit ()

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.

Throws
WebObjectsException

public String toString ()

public SimpleList types ()

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.

Returns
  • A SimpleList reflecting the types of objects which will be searched for.

public void usedBy (int type)

The resulting objects of the search is used by objects of the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

Parameters
type specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

public 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). Note that the SimpleList returned can only have WebObjectInfo objects added to it.

Returns
  • A SimpleList reflecting the used-by objects which will constrain the search.

public 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). Note that the SimpleList returned can only have WebObjectInfo objects added to it.

Returns
  • A SimpleList reflecting the uses objects which will constrain the search.

public void uses (int type)

The resulting objects of the search uses the specified type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

Parameters
type specify type (EnumDSSXMLObjectTypes) or subtype (EnumDSSXMLObjectSubTypes).

Protected Methods

protected boolean checkAccessFlags (int flags)

protected boolean checkAccessRights (String feature)

protected boolean checkPrivilege (String feature)

Throws
WebObjectsException

protected WebOIDOMHandler createDOMHandler ()

protected WebOIDisplayXMLHandler createDisplayXMLHandler ()

protected WebOISAXParser createSAXParser ()

protected WebOIXMLBuilder createXMLBuilder ()

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

protected String getExtParams ()

protected String getXMLForSave ()

protected void handleOiBody (SAXSupport parser, String local, Attributes attrs)

Throws
SAXException

protected void handleOiEnd (SAXSupport parser, String local, String buf)

protected boolean isBodyDirty ()

protected boolean 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.

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

Throws
SAXException

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)