Class FindDomainsRequest

  • All Implemented Interfaces:
    Serializable

    public class FindDomainsRequest
    extends CursorPagedRequest
    The search criteria for domains.

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

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

    By default a result containing 1000 domains is returned.

    See Also:
    Serialized Form
    • Constructor Detail

      • FindDomainsRequest

        public FindDomainsRequest()
    • Method Detail

      • getName

        public String getName()
        The name of the domain 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.
      • isExcludeMeta

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

        public UUID getCommunityId()
        The ID of the community to find the domains in.
      • getTypeId

        public UUID getTypeId()
        The ID of the domain type to search for. Returned domains are of this type.
      • isIncludeSubCommunities

        public boolean isIncludeSubCommunities()
        The include sub-communities flag. When set to true, sub-communities (of the community indicated via the communityId parameter) will be searched in. Defaults to false.
      • setName

        public void setName​(String name)
        The name of the domain 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.
      • setExcludeMeta

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

        public void setCommunityId​(UUID communityId)
        The ID of the community to find the domains in.
      • setTypeId

        public void setTypeId​(UUID typeId)
        The ID of the domain type to search for. Returned domains are of this type.
      • setIncludeSubCommunities

        public void setIncludeSubCommunities​(boolean includeSubCommunities)
        The include sub-communities flag. When set to true, sub-communities (of the community indicated via the communityId parameter) will be searched in. Defaults to false.