Package com.symphony.bdk.gen.api.model

Class RoomSearchCriteria

java.lang.Object

com.symphony.bdk.gen.api.model.RoomSearchCriteria

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-21T12:32:00.966422795Z[Etc/UTC]")
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 enum	RoomSearchCriteria.SortOrderEnum	Sort algorithm to be used.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTIVE
static final String	JSON_PROPERTY_CREATOR
static final String	JSON_PROPERTY_LABELS
static final String	JSON_PROPERTY_MEMBER
static final String	JSON_PROPERTY_OWNER
static final String	JSON_PROPERTY_PRIVATE
static final String	JSON_PROPERTY_QUERY
static final String	JSON_PROPERTY_SORT_ORDER

Constructor Summary

Constructors

Constructor	Description
RoomSearchCriteria()

Method Summary

Modifier and Type	Method	Description
RoomSearchCriteria	_private(Boolean _private)
RoomSearchCriteria	active(Boolean active)
RoomSearchCriteria	addLabelsItem(String labelsItem)
RoomSearchCriteria	creator(UserId creator)
boolean	equals(Object o)	Return true if this RoomSearchCriteria object is equal to o.
Boolean	getActive()	Restrict the search to active/inactive rooms.
UserId	getCreator()	Get creator
List<String>	getLabels()	A list of room tag labels whose values will be queried.
UserId	getMember()	Get member
UserId	getOwner()	Get owner
Boolean	getPrivate()	Restrict the search to private rooms.
String	getQuery()	The search query.
RoomSearchCriteria.SortOrderEnum	getSortOrder()	Sort algorithm to be used.
int	hashCode()
RoomSearchCriteria	labels(List<String> labels)
RoomSearchCriteria	member(UserId member)
RoomSearchCriteria	owner(UserId owner)
RoomSearchCriteria	query(String query)
void	setActive(Boolean active)
void	setCreator(UserId creator)
void	setLabels(List<String> labels)
void	setMember(UserId member)
void	setOwner(UserId owner)
void	setPrivate(Boolean _private)
void	setQuery(String query)
void	setSortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)
RoomSearchCriteria	sortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

• Constant Field Values

JSON_PROPERTY_LABELS

public static final String JSON_PROPERTY_LABELS

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVE

public static final String JSON_PROPERTY_ACTIVE

See Also:

• Constant Field Values

JSON_PROPERTY_PRIVATE

public static final String JSON_PROPERTY_PRIVATE

See Also:

• Constant Field Values

JSON_PROPERTY_OWNER

public static final String JSON_PROPERTY_OWNER

See Also:

• Constant Field Values

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

See Also:

• Constant Field Values

JSON_PROPERTY_MEMBER

public static final String JSON_PROPERTY_MEMBER

See Also:

• Constant Field Values

JSON_PROPERTY_SORT_ORDER

public static final String JSON_PROPERTY_SORT_ORDER

See Also:

• Constant Field Values

Constructor Details

RoomSearchCriteria

public RoomSearchCriteria()

Method Details

query

public RoomSearchCriteria query(String query)

getQuery

public String getQuery()

The search query. Matches the room name and description.

Returns:

query

setQuery

public void setQuery(String query)

labels

public RoomSearchCriteria labels(List<String> labels)

addLabelsItem

public RoomSearchCriteria addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

A list of room tag labels whose values will be queried.

Returns:

labels

setLabels

public void setLabels(List<String> labels)

active

public RoomSearchCriteria active(Boolean active)

getActive

@Nullable
public Boolean getActive()

Restrict the search to active/inactive rooms. If unspecified, search all rooms.

Returns:

active

setActive

public void setActive(Boolean active)

_private

public RoomSearchCriteria _private(Boolean _private)

getPrivate

@Nullable
public Boolean getPrivate()

Restrict the search to private rooms. If unspecified, search all rooms.

Returns:

_private

setPrivate

public void setPrivate(Boolean _private)

owner

public RoomSearchCriteria owner(UserId owner)

getOwner

@Nullable
public UserId getOwner()

Get owner

Returns:

owner

setOwner

public void setOwner(UserId owner)

creator

public RoomSearchCriteria creator(UserId creator)

getCreator

@Nullable
public UserId getCreator()

Get creator

Returns:

creator

setCreator

public void setCreator(UserId creator)

member

public RoomSearchCriteria member(UserId member)

getMember

@Nullable
public UserId getMember()

Get member

Returns:

member

setMember

public void setMember(UserId member)

sortOrder

public RoomSearchCriteria sortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)

getSortOrder

@Nullable
public RoomSearchCriteria.SortOrderEnum 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)

equals

public boolean equals(Object o)

Return true if this RoomSearchCriteria object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object