Class FindCommunitiesRequest

  • All Implemented Interfaces:
    Serializable

    public class FindCommunitiesRequest
    extends CursorPagedRequest
    The search criteria for communities.

    Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

    The returned communities satisfy all constraints that are specified in this search criteria.

    By default a result containing 1000 communities is returned.

    See Also:
    Serialized Form
    • Constructor Detail

      • FindCommunitiesRequest

        public FindCommunitiesRequest()
    • Method Detail

      • getName

        public String getName()
        The name of the community to search for.
      • getNameMatchMode

        public MatchMode getNameMatchMode()
        The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive. Defaults to ANYWHERE.
      • getParentId

        public UUID getParentId()
        The ID of the parent community to find the communities in.
      • isExcludeMeta

        public boolean isExcludeMeta()
        The exclude meta flag. If this is set to true then the meta communities will not be returned (meta communities are i.e. communities not created manually by the user). Defaults to true.
      • getSortOrder

        public SortOrder getSortOrder()
        The sorting order. Defaults to ASC (ascending).
      • setName

        public void setName​(String name)
        The name of the community to search for.
      • setNameMatchMode

        public void setNameMatchMode​(MatchMode nameMatchMode)
        The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive. Defaults to ANYWHERE.
      • setParentId

        public void setParentId​(UUID parentId)
        The ID of the parent community to find the communities in.
      • setExcludeMeta

        public void setExcludeMeta​(boolean excludeMeta)
        The exclude meta flag. If this is set to true then the meta communities will not be returned (meta communities are i.e. communities not created manually by the user). Defaults to true.
      • setSortField

        public void setSortField​(@NotNull
                                 @NotNull FindCommunitiesRequest.SortField sortField)
        The field on which the results are sorted. Defaults to NAME.
      • setSortOrder

        public void setSortOrder​(SortOrder sortOrder)
        The sorting order. Defaults to ASC (ascending).