Package org.silverpeas.core.admin.user.model

Class GroupsSearchCriteria

  • All Implemented Interfaces:
    SearchCriteria
    public class GroupsSearchCriteria
extends Object
implements SearchCriteria
    A conjunction of criteria in the search of user groups.

    • Constructor Detail

      • GroupsSearchCriteria

        public GroupsSearchCriteria()

    • Method Detail

      • onName

        public GroupsSearchCriteria onName​(String name)
        Description copied from interface: SearchCriteria
        Appends a criterion on the resources name for which the search must be constrained to. The name of the resources to fetch have to satisfy this criterion.
        Specified by:
        onName in interface SearchCriteria
        Parameters:
        name - a pattern on the name the resources to fetch must have.
        Returns:
        the criteria enriched with a criterion on the resource name.

      • onComponentInstanceId

        public GroupsSearchCriteria onComponentInstanceId​(String instanceId)
        Description copied from interface: SearchCriteria
        Appends a criterion on the component instance for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion.
        Specified by:
        onComponentInstanceId in interface SearchCriteria
        Parameters:
        instanceId - the unique identifier of the component instance.
        Returns:
        the criteria enriched with a criterion on the component instance.

      • withChildren

        public GroupsSearchCriteria withChildren()
        Indicates to service to retrieve all the children (of matching groups) which are matching the criteria.
        Returns:
        the criteria enriched with the directive of getting also the children.

      • onRoleNames

        public GroupsSearchCriteria onRoleNames​(String... roleIds)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user roles for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion. This criterion replaces any previous criterion on the user roles.

        This criterion is useless without any criterion on either the component instance or on both the component instance and the resource for which the roles are defined.

        Specified by:
        onRoleNames in interface SearchCriteria
        Parameters:
        roleIds - the name of the user roles on which the criterion has to be built.
        Returns:
        the criteria enriched with a criterion on the role names.

      • onGroupIds

        public GroupsSearchCriteria onGroupIds​(String... groupIds)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user groups for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion. This criterion replaces any previous criterion on the user groups.
        Specified by:
        onGroupIds in interface SearchCriteria
        Parameters:
        groupIds - the unique identifiers of the groups.
        Returns:
        the criteria enriched with a criterion on the user groups.

      • onAsRootGroup

        public GroupsSearchCriteria onAsRootGroup()
        The groups must be root ones.
        Returns:
        itself.

      • onSuperGroupId

        public GroupsSearchCriteria onSuperGroupId​(String superGroupId)
        The groups must have as parent the specified super group.
        Parameters:
        superGroupId - the unique identifier of the super group.
        Returns:
        itself.

      • onDomainIds

        public GroupsSearchCriteria onDomainIds​(String... domainIds)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user domain for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion. This criterion replaces any previous criterion on the user domains.
        Specified by:
        onDomainIds in interface SearchCriteria
        Parameters:
        domainIds - the unique identifier of the user domain.
        Returns:
        the criteria enriched with a criterion on the user domain.

      • onAccessLevels

        public GroupsSearchCriteria onAccessLevels​(UserAccessLevel... accessLevels)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user access level for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion. This criterion replaces any previous criterion on the user access levels.
        Specified by:
        onAccessLevels in interface SearchCriteria
        Parameters:
        accessLevels - the access levels aimed.
        Returns:
        the criteria enriched with a criterion on the user access level.

      • onUserStatesToExclude

        public SearchCriteria onUserStatesToExclude​(UserState... userStates)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user states to be excluded in the search of users. The properties of the resources to fetch have to satisfy this criterion. By default, the deleted users are always excluded but not the removed users. Latter have to be explicitly excluded. This criterion replaces any previous criterion on the user states.
        Specified by:
        onUserStatesToExclude in interface SearchCriteria
        Parameters:
        userStates - the user states that exclude users from the result.
        Returns:
        the criteria enriched with a criterion on the user states.

      • onMixedDomainOrOnDomainId

        public GroupsSearchCriteria onMixedDomainOrOnDomainId​(String domainId)
        The groups must belong to either the mixed domain or the specified one.
        Parameters:
        domainId - the unique identifier of a domain.
        Returns:
        itself.

      • isCriterionOnRoleNamesSet

        public boolean isCriterionOnRoleNamesSet()

      • isCriterionOnResourceIdSet

        public boolean isCriterionOnResourceIdSet()

      • isCriterionOnComponentInstanceIdSet

        public boolean isCriterionOnComponentInstanceIdSet()

      • isCriterionOnSuperGroupIdSet

        public boolean isCriterionOnSuperGroupIdSet()

      • isCriterionOnGroupIdsSet

        public boolean isCriterionOnGroupIdsSet()

      • isCriterionOnDomainIdSet

        public boolean isCriterionOnDomainIdSet()

      • isCriterionOnAccessLevelsSet

        public boolean isCriterionOnAccessLevelsSet()

      • isCriterionOnUserStatesToExcludeSet

        public boolean isCriterionOnUserStatesToExcludeSet()

      • isCriterionOnMixedDomainIdSet

        public boolean isCriterionOnMixedDomainIdSet()

      • isCriterionOnUserIdsSet

        public boolean isCriterionOnUserIdsSet()

      • isCriterionOnNameSet

        public boolean isCriterionOnNameSet()

      • isCriterionOnPaginationSet

        public boolean isCriterionOnPaginationSet()

      • childrenRequired

        public boolean childrenRequired()

      • mustBeRoot

        public boolean mustBeRoot()

      • getCriterionOnRoleNames

        public String[] getCriterionOnRoleNames()
        Gets the conjunction on the role names.
        Returns:
        an array with each element of the conjunction.

      • getAndClearCriterionOnRoleNames

        public String[] getAndClearCriterionOnRoleNames()
        Gets and clears the conjunction on the role names.
        Returns:
        an array with each element of the conjunction.

      • getCriterionOnResourceId

        public String getCriterionOnResourceId()
        Gets the resource for which the user or the group must have access rights.
        Returns:
        the unique identifier of the resource in a component instance.

      • getCriterionOnComponentInstanceId

        public String getCriterionOnComponentInstanceId()
        Gets the component instance the user or the group must belongs to.
        Returns:
        the unique identifier of the component instance.

      • getCriterionOnSuperGroupId

        public String getCriterionOnSuperGroupId()
        Gets the conjunction on the super group identifiers.
        Returns:
        an array with each element of the conjunction.

      • getCriterionOnUserIds

        public String[] getCriterionOnUserIds()
        Gets the conjunction on the user identifiers.
        Returns:
        an array with each element of the conjunction.

      • getCriterionOnGroupIds

        public String[] getCriterionOnGroupIds()
        Gets the conjunction on the group identifiers.
        Returns:
        an array with each element of the conjunction.

      • getCriterionOnDomainIds

        public String[] getCriterionOnDomainIds()
        Gets the domain identifier onto which the groups must belong. It can include the mixed domain.
        Returns:
        the identifier of the domain.

      • getCriterionOnAccessLevels

        public UserAccessLevel[] getCriterionOnAccessLevels()
        Gets access level criterion.
        Returns:
        the access level criterion.

      • getCriterionOnUserStatesToExclude

        public UserState[] getCriterionOnUserStatesToExclude()
        Gets user states to exclude criterion.
        Returns:
        the access level criterion.

      • getCriterionOnName

        public String getCriterionOnName()
        Gets the pattern on the name the group or the user name must satisfy.
        Returns:
        a pattern on the user or group name.

      • getCriterionOnPagination

        public PaginationPage getCriterionOnPagination()
        Gets the pagination page into which the groups to return has to be part.
        Returns:
        the page in a pagination mechanism to fetch.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: SearchCriteria
        Is this criteria empty?
        Specified by:
        isEmpty in interface SearchCriteria
        Returns:
        true if this object has no any criteria, false otherwise.

      • onUserIds

        public SearchCriteria onUserIds​(String... userIds)
        Not relevent here. Does nothing.
        Specified by:
        onUserIds in interface SearchCriteria
        Parameters:
        userIds - the user identifiers.
        Returns:
        itself.

      • onUserSpecificIds

        public SearchCriteria onUserSpecificIds​(String... userSpecificIds)
        Description copied from interface: SearchCriteria
        Appends a criterion on the user profiles for which the search must be constrained to. The properties of the resources to fetch have to satisfy this criterion.

        One, and only one, domain id will be mandatory!

        This criterion replaces any previous criterion on the user profiles.
        Specified by:
        onUserSpecificIds in interface SearchCriteria
        Parameters:
        userSpecificIds - the user specific identifiers.
        Returns:
        the criteria enriched with a criterion on the user identifiers.

      • onResourceId

        public SearchCriteria onResourceId​(String resourceId)
        Description copied from interface: SearchCriteria
        Appends a criterion on a given component instance's resource for which the search must be constrained to. This criterion has a meaning only when coupled with the criterion on the component instance. The properties of the resources to fetch have to satisfy both the criterion on the component instance and this one.
        Specified by:
        onResourceId in interface SearchCriteria
        Parameters:
        resourceId - the unique identifier of the resource managed in the component instance. As each resource is particular to a given Silverpeas component, the unique identifier is made up of the resource type and of the resource identifier.
        Returns:
        the criteria enriched with a criterion on the resource in the component instance.

      • onPagination

        public SearchCriteria onPagination​(PaginationPage page)
        Description copied from interface: SearchCriteria
        Appends a criterion on a resources pagination. The pagination is a mechanism to distribute the resources to fetch in one or more pages of same size and to navigate among theses different available pages. Yet, this criterion is about the page of resources to fetch.
        Specified by:
        onPagination in interface SearchCriteria
        Parameters:
        page - the page of resources to fetch.
        Returns:
        the criteria enriched with a criterion on the resources pagination.