SynchronousQuickSearch.Builder
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.webapi.paramsobject.SynchronousQuickSearch.Builder |
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Builder() | |||||||||||
| Builder(SynchronousQuickSearch quickSearchObject) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SynchronousQuickSearch.Builder |
beginCreateTime(String beginCreateTime)
Begin Create Time GMT.
| ||||||||||
| SynchronousQuickSearch.Builder |
beginModifyTime(String beginModifyTime)
Begin Modify Time GMT.
| ||||||||||
| SynchronousQuickSearch |
build()
Build SynchronousQuickSearch object
| ||||||||||
| SynchronousQuickSearch.Builder |
count(int count)
Set the max number of objects to be returned, usually equals to the page size.
| ||||||||||
| SynchronousQuickSearch.Builder |
descriptionPattern(String descriptionPattern)
Query in object description.
| ||||||||||
| SynchronousQuickSearch.Builder | documentTypes(String documentTypes) | ||||||||||
| SynchronousQuickSearch.Builder |
endCreateTime(String endCreateTime)
End Create Time GMT.
| ||||||||||
| SynchronousQuickSearch.Builder |
endModifyTime(String endModifyTime)
End Modify Time GMT.
| ||||||||||
| SynchronousQuickSearch.Builder |
includeManagedObject(boolean includeManagedObject)
Set whether include managed objects
| ||||||||||
| SynchronousQuickSearch.Builder |
namePattern(String namePattern)
Query in object name, If namePattern is empty, it means search all objects.
| ||||||||||
| SynchronousQuickSearch.Builder |
outputType(int outputType)
Define the output type of the search result.
| ||||||||||
| SynchronousQuickSearch.Builder |
ownerIds(String ownerIds)
Define owner ID(s) we need to search in objects owned by.
| ||||||||||
| SynchronousQuickSearch.Builder |
quickSearchCertifiedStatus(EnumDSSXMLQuickSearchCertifiedStatus quickSearchCertifiedStatus)
Set quickSearchCertifiedStatus 0 -> return none certified only; 1 -> return certfied only; 2 -> return both certified and none certified object
| ||||||||||
| SynchronousQuickSearch.Builder |
quickSearchCmd(int quickSearchCmd)
Set what type of data need to get back from the quick search command.
| ||||||||||
| SynchronousQuickSearch.Builder |
quickSearchFields(Integer quickSearchFields)
Set quickSearchFields, the fields of the quick search
| ||||||||||
| SynchronousQuickSearch.Builder | quickSearchMode(EnumDSSXMLQuickSearchMode quickSearchMode) | ||||||||||
| SynchronousQuickSearch.Builder |
quickSearchVisibility(EnumDSSXMLQuickSearchVisibility quickSearchVisibility)
Set quick search visibility, 0 -> return visible object only; 1 -> return hidden object only; 2 -> return both hidden and visible object
| ||||||||||
| SynchronousQuickSearch.Builder |
recommendationQueryString(String recommendationQueryString)
Set sourceObjectProjectId, the source object project id for the recommendation
| ||||||||||
| SynchronousQuickSearch.Builder |
recursive(boolean recursive)
Set whether search in sub folders recursively, 0 means false, others means true.
| ||||||||||
| SynchronousQuickSearch.Builder |
resolveShortcut(boolean resolveShortcut)
Set resolve shortcut to target
| ||||||||||
| SynchronousQuickSearch.Builder | sXProjIDs(String sXProjIDs) | ||||||||||
| SynchronousQuickSearch.Builder |
searchFolders(String searchFolders)
Set search Folders
| ||||||||||
| SynchronousQuickSearch.Builder |
searchType(int searchType)
Set the type of quick search, 0=contains, 2=exactly, 3=beginwith, 5=endwith; -1=not use quick search
Optional parameter | ||||||||||
| SynchronousQuickSearch.Builder |
sessionID(String sessionID)
Set a valid Session ID.
| ||||||||||
| SynchronousQuickSearch.Builder |
sourceObjectId(String sourceObjectId)
Set sourceObjectId, the source object id for the recommendation
| ||||||||||
| SynchronousQuickSearch.Builder |
sourceObjectProjectId(String sourceObjectProjectId)
Set sourceObjectProjectId, the source object project id for the recommendation
| ||||||||||
| SynchronousQuickSearch.Builder |
sourceObjectType(int sourceObjectType)
Set sourceObjectType, the source object type for the recommendation
| ||||||||||
| SynchronousQuickSearch.Builder |
startObject(int startObject)
Set startObject
| ||||||||||
| SynchronousQuickSearch.Builder |
types(String types)
Define the object type(s) we need to search.
| ||||||||||
| SynchronousQuickSearch.Builder | userEnabledStatus(EnumDSSXMLQuickSearchEnabledStatus userEnabledStatus) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Builder ()
Public Methods
public SynchronousQuickSearch.Builder beginCreateTime (String beginCreateTime)
Begin Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
public SynchronousQuickSearch.Builder beginModifyTime (String beginModifyTime)
Begin Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
public SynchronousQuickSearch.Builder count (int count)
Set the max number of objects to be returned, usually equals to the page size.
public SynchronousQuickSearch.Builder descriptionPattern (String descriptionPattern)
Query in object description.
public SynchronousQuickSearch.Builder endCreateTime (String endCreateTime)
End Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
public SynchronousQuickSearch.Builder endModifyTime (String endModifyTime)
End Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
public SynchronousQuickSearch.Builder includeManagedObject (boolean includeManagedObject)
Set whether include managed objects
public SynchronousQuickSearch.Builder namePattern (String namePattern)
Query in object name, If namePattern is empty, it means search all objects.
public SynchronousQuickSearch.Builder outputType (int outputType)
Define the output type of the search result. "1" means json type, "2" means XML type.
public SynchronousQuickSearch.Builder ownerIds (String ownerIds)
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 SynchronousQuickSearch.Builder quickSearchCertifiedStatus (EnumDSSXMLQuickSearchCertifiedStatus quickSearchCertifiedStatus)
Set quickSearchCertifiedStatus 0 -> return none certified only; 1 -> return certfied only; 2 -> return both certified and none certified object
public SynchronousQuickSearch.Builder quickSearchCmd (int quickSearchCmd)
Set 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 SynchronousQuickSearch.Builder quickSearchFields (Integer quickSearchFields)
Set quickSearchFields, the fields of the quick search
public SynchronousQuickSearch.Builder quickSearchVisibility (EnumDSSXMLQuickSearchVisibility quickSearchVisibility)
Set quick search visibility, 0 -> return visible object only; 1 -> return hidden object only; 2 -> return both hidden and visible object
public SynchronousQuickSearch.Builder recommendationQueryString (String recommendationQueryString)
Set sourceObjectProjectId, the source object project id for the recommendation
public SynchronousQuickSearch.Builder recursive (boolean recursive)
Set whether search in sub folders recursively, 0 means false, others means true.
public SynchronousQuickSearch.Builder resolveShortcut (boolean resolveShortcut)
Set resolve shortcut to target
public SynchronousQuickSearch.Builder searchFolders (String searchFolders)
Set search Folders
Parameters
| searchFolders | 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 SynchronousQuickSearch.Builder searchType (int searchType)
Set the type of quick search, 0=contains, 2=exactly, 3=beginwith, 5=endwith; -1=not use quick search
Optional parameter
public SynchronousQuickSearch.Builder sourceObjectId (String sourceObjectId)
Set sourceObjectId, the source object id for the recommendation
public SynchronousQuickSearch.Builder sourceObjectProjectId (String sourceObjectProjectId)
Set sourceObjectProjectId, the source object project id for the recommendation
public SynchronousQuickSearch.Builder sourceObjectType (int sourceObjectType)
Set sourceObjectType, the source object type for the recommendation
public SynchronousQuickSearch.Builder startObject (int startObject)
Set startObject
Parameters
| startObject | 0 based, the start index of returned objects. |
|---|
public SynchronousQuickSearch.Builder types (String types)
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.