public class

SynchronousQuickSearch

extends Object
java.lang.Object
   ↳ com.microstrategy.webapi.paramsobject.SynchronousQuickSearch

Class Overview

Object that represents a synchronous quick search and that can be used as a parameter object (in the XML API layer)

Summary

Nested Classes
class SynchronousQuickSearch.Builder  
Public Methods
String getBeginCreateTime()
String getBeginModifyTime()
int getCount()
String getDescriptionPattern()
String getDocumentTypes()
String getEndCreateTime()
String getEndModifyTime()
String getNamePattern()
int getOutputType()
String getOwnerIds()
EnumDSSXMLQuickSearchCertifiedStatus getQuickSearchCertifiedStatus()
int getQuickSearchCmd()
Integer getQuickSearchFields()
EnumDSSXMLQuickSearchMode getQuickSearchMode()
EnumDSSXMLQuickSearchVisibility getQuickSearchVisibility()
String getRecommendationQueryString()
String getSearchFolders()
int getSearchType()
String getSessionID()
String getSourceObjectId()
String getSourceObjectProjectId()
int getSourceObjectType()
int getStartObject()
String getTypes()
EnumDSSXMLQuickSearchEnabledStatus getUserEnabledStatus()
String getsXProjIDs()
boolean isIncludeManagedObject()
boolean isRecursive()
boolean isResolveShortcut()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public String getBeginCreateTime ()

Returns
  • Begin Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).

public String getBeginModifyTime ()

Returns
  • Begin Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).

public int getCount ()

Returns
  • The max number of objects to be returned, usually equals to the page size.

public String getDescriptionPattern ()

Returns
  • Query in object description.

public String getDocumentTypes ()

public String getEndCreateTime ()

Returns
  • End Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).

public String getEndModifyTime ()

Returns
  • End Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).

public String getNamePattern ()

Returns
  • Query in object name, If namePattern is empty, it means search all objects.

public int getOutputType ()

Returns
  • Define the output type of the search result. "1" means json type, "2" means XML type.

public String getOwnerIds ()

Returns
  • Define owner ID(s) we need to search in objects owned by. Define owner ID(s) we need to search in objects owned by. If there are multiple owners, the ids should be separated by space.

public EnumDSSXMLQuickSearchCertifiedStatus getQuickSearchCertifiedStatus ()

Returns
  • 0 -> return none certified only; 1 -> return certfied only; 2 -> return both certified and none certified object

public int getQuickSearchCmd ()

Returns
  • Mean what type of data need to get back from the quick search command. quickSearchCmd=1 means get quick search status, quickSearchCmd=2 means do quick search.

public Integer getQuickSearchFields ()

Returns
  • Quick search fields

public EnumDSSXMLQuickSearchMode getQuickSearchMode ()

public EnumDSSXMLQuickSearchVisibility getQuickSearchVisibility ()

Returns
  • 0 -> return visible object only; 1 -> return hidden object only; 2 -> return both hidden and visible object

public String getRecommendationQueryString ()

Returns
  • recommendation query string the source object of the recommendation

public String getSearchFolders ()

Returns
  • Define folder ID(s) we need to search in which folder/folders. If there are multiple folders, the ids should be separated by space.

public int getSearchType ()

Returns

public String getSessionID ()

Returns
  • A valid Session ID.

public String getSourceObjectId ()

Returns
  • Object id of the source object of the recommendation

public String getSourceObjectProjectId ()

Returns
  • Project if of the source object of the recommendation

public int getSourceObjectType ()

Returns
  • Object type of the source object of the recommendation

public int getStartObject ()

Returns
  • 0 based, the start index of returned objects.

public String getTypes ()

Returns
  • Define the object type(s) we need to search. If there are multiple types, the types should be separated by space. It could be either type or subtype.

public EnumDSSXMLQuickSearchEnabledStatus getUserEnabledStatus ()

public String getsXProjIDs ()

Returns
  • A list of project ids. It is a space delimited list of GUIDs.

public boolean isIncludeManagedObject ()

Returns
  • Whether include managed objects

public boolean isRecursive ()

Returns
  • Whether search in sub folders recursively, 0 means false, others means true.

public boolean isResolveShortcut ()

Returns
  • Resolve shortcut to target