Package com.symphony.api.model
Class RoomSearchCriteria
- java.lang.Object
-
- com.symphony.api.model.RoomSearchCriteria
-
- Direct Known Subclasses:
V2RoomSearchCriteria
public class RoomSearchCriteria extends Object
Room Query Object. Used to specify the parameters for room search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RoomSearchCriteria.SortOrderEnum
-
Constructor Summary
Constructors Constructor Description RoomSearchCriteria()
-
Method Summary
-
-
-
Method Detail
-
getQuery
public String getQuery()
The search query. Matches the room name and description.- Returns:
- query
-
setQuery
public void setQuery(String query)
-
query
public RoomSearchCriteria query(String query)
-
getLabels
public List<String> getLabels()
A list of room tag labels whose values will be queried.- Returns:
- labels
-
labels
public RoomSearchCriteria labels(List<String> labels)
-
addLabelsItem
public RoomSearchCriteria addLabelsItem(String labelsItem)
-
isisActive
public Boolean isisActive()
Restrict the search to active/inactive rooms. If unspecified, search all rooms.- Returns:
- active
-
setActive
public void setActive(Boolean active)
-
active
public RoomSearchCriteria active(Boolean active)
-
isisPrivate
public Boolean isisPrivate()
Restrict the search to private rooms. If unspecified, search all rooms.- Returns:
- _private
-
setPrivate
public void setPrivate(Boolean _private)
-
_private
public RoomSearchCriteria _private(Boolean _private)
-
getOwner
public UserId getOwner()
Get owner- Returns:
- owner
-
setOwner
public void setOwner(UserId owner)
-
owner
public RoomSearchCriteria owner(UserId owner)
-
getCreator
public UserId getCreator()
Get creator- Returns:
- creator
-
setCreator
public void setCreator(UserId creator)
-
creator
public RoomSearchCriteria creator(UserId creator)
-
getMember
public UserId getMember()
Get member- Returns:
- member
-
setMember
public void setMember(UserId member)
-
member
public RoomSearchCriteria member(UserId member)
-
getSortOrder
public String getSortOrder()
Sort algorithm to be used. Supports two values: \"BASIC\" (legacy algorithm) and \"RELEVANCE\" (enhanced algorithm).- Returns:
- sortOrder
-
setSortOrder
public void setSortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)
-
sortOrder
public RoomSearchCriteria sortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)
-
-