org.symphonyoss.symphony.pod.model

Class RoomSearchCriteria

java.lang.Object

org.symphonyoss.symphony.pod.model.RoomSearchCriteria

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:29:05.070-05:00")
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 and Description
static class	RoomSearchCriteria.SortOrderEnum Sort algorithm to be used.

Constructor Summary

Constructors

Constructor and Description
RoomSearchCriteria()

Method Summary

Modifier and Type	Method and Description
RoomSearchCriteria	_private(Boolean _private)
RoomSearchCriteria	active(Boolean active)
RoomSearchCriteria	addLabelsItem(String labelsItem)
RoomSearchCriteria	creator(UserId creator)
boolean	equals(Object o)
Boolean	getActive() Restrict the search to active/inactive rooms.
UserId	getCreator() Restrict the search to rooms created by the specified user ID.
List<String>	getLabels() A list of room tag labels whose values will be queried.
UserId	getMember() Restrict the search to rooms having the specified user ID as member.
UserId	getOwner() Restrict the search to rooms owned by the specified user ID.
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

Constructor Detail

RoomSearchCriteria

public RoomSearchCriteria()

Method Detail

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

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

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

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

public UserId getOwner()

Restrict the search to rooms owned by the specified user ID.

Returns:

owner

setOwner

public void setOwner(UserId owner)

creator

public RoomSearchCriteria creator(UserId creator)

getCreator

public UserId getCreator()

Restrict the search to rooms created by the specified user ID.

Returns:

creator

setCreator

public void setCreator(UserId creator)

member

public RoomSearchCriteria member(UserId member)

getMember

public UserId getMember()

Restrict the search to rooms having the specified user ID as member.

Returns:

member

setMember

public void setMember(UserId member)

sortOrder

public RoomSearchCriteria sortOrder(RoomSearchCriteria.SortOrderEnum sortOrder)

getSortOrder

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)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object