Class SynchronousQuickSearch
- java.lang.Object
-
- com.microstrategy.webapi.paramsobject.SynchronousQuickSearch
-
public class SynchronousQuickSearch extends java.lang.Object
Object that represents a synchronous quick search and that can be used as a parameter object (in the XML API layer)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SynchronousQuickSearch.Builder
-
Method Summary
-
-
-
Method Detail
-
getSessionID
public java.lang.String getSessionID()
- Returns:
- A valid Session ID.
-
getQuickSearchCmd
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.
-
getNamePattern
public java.lang.String getNamePattern()
- Returns:
- Query in object name, If namePattern is empty, it means search all objects.
-
getStartObject
public int getStartObject()
- Returns:
- 0 based, the start index of returned objects.
-
getCount
public int getCount()
- Returns:
- The max number of objects to be returned, usually equals to the page size.
-
getSearchType
public int getSearchType()
- Returns:
- The type of quick search,
EnumDSSXMLSearchTypes
-
getDescriptionPattern
public java.lang.String getDescriptionPattern()
- Returns:
- Query in object description.
-
isRecursive
public boolean isRecursive()
- Returns:
- Whether search in sub folders recursively, 0 means false, others means true.
-
isIncludeManagedObject
public boolean isIncludeManagedObject()
- Returns:
- Whether include managed objects
-
isResolveShortcut
public boolean isResolveShortcut()
- Returns:
- Resolve shortcut to target
-
getSearchFolders
public java.lang.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.
-
getOwnerIds
public java.lang.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.
-
getTypes
public java.lang.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.
-
getBeginCreateTime
public java.lang.String getBeginCreateTime()
- Returns:
- Begin Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
-
getEndCreateTime
public java.lang.String getEndCreateTime()
- Returns:
- End Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
-
getBeginModifyTime
public java.lang.String getBeginModifyTime()
- Returns:
- Begin Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
-
getEndModifyTime
public java.lang.String getEndModifyTime()
- Returns:
- End Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
-
getOutputType
public int getOutputType()
- Returns:
- Define the output type of the search result. "1" means json type, "2" means XML type.
-
getsXProjIDs
public java.lang.String getsXProjIDs()
- Returns:
- A list of project ids. It is a space delimited list of GUIDs.
-
getQuickSearchVisibility
public EnumDSSXMLQuickSearchVisibility getQuickSearchVisibility()
- Returns:
- 0 -> return visible object only; 1 -> return hidden object only; 2 -> return both hidden and visible object
-
getQuickSearchCertifiedStatus
public EnumDSSXMLQuickSearchCertifiedStatus getQuickSearchCertifiedStatus()
- Returns:
- 0 -> return none certified only; 1 -> return certfied only; 2 -> return both certified and none certified object
-
getQuickSearchMode
public EnumDSSXMLQuickSearchMode getQuickSearchMode()
-
getSourceObjectId
public java.lang.String getSourceObjectId()
- Returns:
- Object id of the source object of the recommendation
-
getSourceObjectType
public int getSourceObjectType()
- Returns:
- Object type of the source object of the recommendation
-
getRecommendationQueryString
public java.lang.String getRecommendationQueryString()
- Returns:
- recommendation query string the source object of the recommendation
-
getSourceObjectProjectId
public java.lang.String getSourceObjectProjectId()
- Returns:
- Project if of the source object of the recommendation
-
getUserEnabledStatus
public EnumDSSXMLQuickSearchEnabledStatus getUserEnabledStatus()
-
getQuickSearchFields
public java.lang.Integer getQuickSearchFields()
- Returns:
- Quick search fields
-
getDocumentTypes
public java.lang.String getDocumentTypes()
-
getTargetUserGroupId
public java.lang.String getTargetUserGroupId()
- Returns:
- The target user group id
-
-