public class SearchDocumentsSdsJson extends BaseJson
Constructor and Description |
---|
SearchDocumentsSdsJson() |
Modifier and Type | Method and Description |
---|---|
Boolean |
getAllStarredDocuments()
Ignore workspace id, return results from SDS and VDR in case of true
|
ApiDocumentOrderSDS |
getDocumentOrder()
Document order, if left empty set to LAST_UPDATED.
|
TrueFalseEither |
getHidden()
When searching only for hidden or un-starred files, if omitted will
return only visible.
|
Boolean |
getIncludeStarredTransientDocuments()
Include transient files in the results
|
Integer |
getPageNumber()
Current page to fetch, if left empty set to 0.
|
Integer |
getPageSize()
Page size for search results, if left empty set to 25.
|
TrueFalseEither |
getRead()
When searching only for read or un-read files, if omitted will return
both.
|
String |
getSearchString()
The query search string.
|
TrueFalseEither |
getStarred()
When searching only for starred or un-starred files, if omitted will
return both.
|
Set<String> |
getWorkspaceTypes()
Workspace types
|
boolean |
isOrderAscending()
File order ascending, if left empty set to false.
|
void |
setAllStarredDocuments(Boolean allStarredDocuments)
Ignore workspace id, return results from SDS and VDR in case of true
|
void |
setDocumentOrder(ApiDocumentOrderSDS documentOrder)
Document order, if left empty set to LAST_UPDATED.
|
void |
setHidden(TrueFalseEither hidden)
When searching only for hidden or un-starred files, if omitted will
return only visible.
|
void |
setIncludeStarredTransientDocuments(Boolean includeStarredTransientDocuments)
Include transient files in the results
|
void |
setOrderAscending(boolean orderAscending)
File order ascending, if left empty set to false.
|
void |
setPageNumber(Integer pageNumber)
Current page to fetch, if left empty set to 0.
|
void |
setPageSize(Integer pageSize)
Page size for search results, if left empty set to 25.
|
void |
setRead(TrueFalseEither read)
When searching only for read or un-read files, if omitted will return
both.
|
void |
setSearchString(String searchString)
The query search string.
|
void |
setStarred(TrueFalseEither starred)
When searching only for starred or un-starred files, if omitted will
return both.
|
void |
setWorkspaceTypes(Set<String> workspaceTypes)
Workspace types
|
getObjType, setObjType, toString
public String getSearchString()
public void setSearchString(String searchString)
searchString
- The query search string.public Boolean getIncludeStarredTransientDocuments()
public void setIncludeStarredTransientDocuments(Boolean includeStarredTransientDocuments)
includeStarredTransientDocuments
- Include transient files in the
resultspublic void setWorkspaceTypes(Set<String> workspaceTypes)
workspaceTypes
- Workspace typespublic Integer getPageNumber()
public void setPageNumber(Integer pageNumber)
pageNumber
- Current page to fetch, if left empty set to 0.public TrueFalseEither getRead()
public void setRead(TrueFalseEither read)
read
- When searching only for read or un-read files, if omitted
will return both.public TrueFalseEither getStarred()
public void setStarred(TrueFalseEither starred)
starred
- When searching only for starred or un-starred files, if
omitted will return both.public TrueFalseEither getHidden()
public void setHidden(TrueFalseEither hidden)
hidden
- When searching only for hidden or un-starred files, if
omitted will return only visible.public boolean isOrderAscending()
public void setOrderAscending(boolean orderAscending)
orderAscending
- File order ascending, if left empty set to false.public Integer getPageSize()
public void setPageSize(Integer pageSize)
pageSize
- Page size for search results, if left empty set to 25.public Boolean getAllStarredDocuments()
public void setAllStarredDocuments(Boolean allStarredDocuments)
allStarredDocuments
- Ignore workspace id, return results from SDS
and VDR in case of truepublic ApiDocumentOrderSDS getDocumentOrder()
public void setDocumentOrder(ApiDocumentOrderSDS documentOrder)
documentOrder
- Document order, if left empty set to LAST_UPDATED.Copyright © 2019. All rights reserved.