com.stratelia.webactiv.beans.admin
Class GroupsSearchCriteria

java.lang.Object
  com.stratelia.webactiv.beans.admin.GroupsSearchCriteria

All Implemented Interfaces:

SearchCriteria

public class GroupsSearchCriteria
extends Object
implements SearchCriteria

A conjonction of criteria in the search of user groups.

Field Summary

Fields inherited from interface com.stratelia.webactiv.beans.admin.SearchCriteria

ANY

Constructor Summary

GroupsSearchCriteria()

Method Summary

SearchCriteria	and() Useless as by default the criteria forms a conjonction.
boolean	equals(Object obj)
UserAccessLevel[]	getCriterionOnAccessLevels() Gets access level criterion.
String	getCriterionOnComponentInstanceId() Gets the component instance the user or the group must belongs to.
String	getCriterionOnDomainId() Gets the domain identifier, other than the mixed domain, onto which the groups must belong.
String[]	getCriterionOnGroupIds() Gets the conjonction on the group identifiers.
String	getCriterionOnName() Gets the pattern on the name the group or the user name must satisfy.
PaginationPage	getCriterionOnPagination() Gets the pagination page into which the groups to return has to be part.
String	getCriterionOnResourceId() Gets the resource for which the user or the group must have access rights.
String[]	getCriterionOnRoleNames() Gets the conjonction on the role names.
String	getCriterionOnSuperGroupId() Gets the conjonction on the user identifiers.
UserState[]	getCriterionOnUserStatesToExclude() Gets user states to exclude criterion.
int	hashCode()
boolean	isCriterionOnAccessLevelsSet()
boolean	isCriterionOnComponentInstanceIdSet()
boolean	isCriterionOnDomainIdSet()
boolean	isCriterionOnGroupIdsSet()
boolean	isCriterionOnMixedDomainIdSet()
boolean	isCriterionOnNameSet()
boolean	isCriterionOnPaginationSet()
boolean	isCriterionOnResourceIdSet()
boolean	isCriterionOnRoleNamesSet()
boolean	isCriterionOnSuperGroupIdSet()
boolean	isCriterionOnUserStatesToExcludeSet()
boolean	isEmpty() Is this criteria empty?
boolean	mustBeRoot()
GroupsSearchCriteria	onAccessLevels(UserAccessLevel... accessLevels) Appends a criterion on the user access level for which the search must be constrained to.
GroupsSearchCriteria	onAsRootGroup() The groups must be root ones.
GroupsSearchCriteria	onComponentInstanceId(String instanceId) Appends a criterion on the component instance for which the search must be constrained to.
GroupsSearchCriteria	onDomainId(String domainId) Appends a criterion on the user domain for which the search must be constrained to.
GroupsSearchCriteria	onGroupIds(String... groupIds) Appends a criterion on the user groups for which the search must be constrained to.
GroupsSearchCriteria	onMixedDomainOrOnDomainId(String domainId) The groups must belong to either the mixed domain or the specified one.
GroupsSearchCriteria	onName(String name) Appends a criterion on the resources name for which the search must be constrained to.
SearchCriteria	onPagination(PaginationPage page) Appends a criteria on a resources pagination.
SearchCriteria	onResourceId(String resourceId) Appends a criterion on a given component instance's resource for which the search must be constrained to.
GroupsSearchCriteria	onRoleNames(String[] roleIds) Appends a criterion on the user roles for which the search must be constrained to.
GroupsSearchCriteria	onSuperGroupId(String superGroupId) The groups must have as parent the specified super group.
SearchCriteria	onUserIds(String... userIds) Not relevent here.
SearchCriteria	onUserStatesToExclude(UserState... userStates) Appends a criteria on the user states that must exclude users from the result.
SearchCriteria	or() Not supported.

Methods inherited from class java.lang.Object

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

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 user 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.

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.

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.

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.

onDomainId

public GroupsSearchCriteria onDomainId(String domainId)

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.

Specified by:

onDomainId in interface SearchCriteria

Parameters:

domainId - 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.

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 criteria on the user states that must exclude users from the result. The properties of the resources to fetch have to satisfy this criterion.

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()

isCriterionOnNameSet

public boolean isCriterionOnNameSet()

isCriterionOnPaginationSet

public boolean isCriterionOnPaginationSet()

mustBeRoot

public boolean mustBeRoot()

getCriterionOnRoleNames

public String[] getCriterionOnRoleNames()

Gets the conjonction on the role names.

Returns:

an array with each element of the conjonction.

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 conjonction on the user identifiers.

Returns:

an array with each element of the conjonction.

getCriterionOnGroupIds

public String[] getCriterionOnGroupIds()

Gets the conjonction on the group identifiers.

Returns:

an array with each element of the conjonction.

getCriterionOnDomainId

public String getCriterionOnDomainId()

Gets the domain identifier, other than the mixed domain, onto which the groups must belong.

Returns:

the identifier of the domain (other than the mixed 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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

and

public SearchCriteria and()

Useless as by default the criteria forms a conjonction.

Specified by:

and in interface SearchCriteria

Returns:

itself.

or

public SearchCriteria or()

Not supported. By default, the criteria form a conjonction.

Specified by:

or in interface SearchCriteria

Returns:

nothing, thrown an UnsupportedOperationException exception.

isEmpty

public boolean isEmpty()

Description copied from interface: SearchCriteria

Is this criteria empty?

Specified by:

isEmpty in interface SearchCriteria

Returns:

true if this criteria has no criterion, 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.

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 criteria 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.