com.communote.server.core.vo.query.user

Class CommunoteEntityQueryParameters

java.lang.Object

com.communote.server.core.vo.query.QueryParameters

com.communote.server.core.vo.query.PropertyQueryParameters

com.communote.server.core.vo.query.user.UserQueryParameters

com.communote.server.core.vo.query.user.CommunoteEntityQueryParameters

public class CommunoteEntityQueryParameters
extends UserQueryParameters

The Class UserManagementQueryInstance.

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary

Nested classes/interfaces inherited from class com.communote.server.core.vo.query.QueryParameters

QueryParameters.OrderDirection

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_EXCLUDE_ASSIGNED_TO_BLOG_ID Query Parameter name for the blog to exclude the members from.
static String	PARAM_EXCLUDE_ENTITY_ID Exclude this entity.
static String	PARAM_MEMBERSHIP_GROUP_ID Parameter for restricting the result to users and groups that are direct members of a group

Fields inherited from class com.communote.server.core.vo.query.user.UserQueryParameters

PARAM_LAST_MODIFICATION_DATE, PARAM_TAG_PREFIX, PARAM_USER_ROLE_FILTER, PLACEHOLDER_USER_ALIAS

Fields inherited from class com.communote.server.core.vo.query.QueryParameters

SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

Constructors

Constructor and Description
CommunoteEntityQueryParameters()

Method Summary

Modifier and Type	Method and Description
Long	getExcludedAssignedToBlogId()
Long	getExcludedEntityId()
Map<String,Object>	getParameters() Get the parameters of this instances, the names are the keys
boolean	isDirectGroupMembership()
boolean	needTransformListItem()
void	setDirectGroupMembershipFilteringGroupId(Long groupId) Set the ID of a group to restrict the result to those users and groups that are direct members of that group.
void	setExcludedAssignedToBlogId(Long excludedAssignedToBlogId) Set an ID of a topic to exclude all Communote entities from the result set which are already a member of that topic
void	setExcludedEntityId(Long excludedEntityId)

Methods inherited from class com.communote.server.core.vo.query.user.UserQueryParameters

addRoleToExclude, addRoleToInclude, addUserTagIds, addUserTagStoreTagId, addUserTagStoreTagId, getExcludeStatusFilter, getIncludeStatusFilter, getLastModifiedAfter, getMatchMode, getRolesToExclude, getRolesToInclude, getTagPrefix, getTagStoreAliases, getUserSearchFilters, getUserSearchParameterNames, getUserTagIds, getUserTagStoreTagIds, isHideSelectedTags, isIgnoreEmailField, isMultilingualTagPrefixSearch, isRetrieveOnlyFollowedUsers, setExcludeStatusFilter, setHideSelectedTags, setIncludeStatusFilter, setLastModifiedAfter, setMatchMode, setRetrieveOnlyFollowedUsers, setTagPrefix, setTagStoreAliases, setUserSearchFilters, setUserSearchFilters, sortByEmailAsc, sortByFirstNameAsc, sortByLastNameAsc, transformResultItem

Methods inherited from class com.communote.server.core.vo.query.PropertyQueryParameters

addPropertyFilter, getPropertyFilters

Methods inherited from class com.communote.server.core.vo.query.QueryParameters

addParameter, addParameter, addSortField, addSortField, createParameterNamesForSearch, getDatabaseConfiguration, getLanguageCode, getPageInformation, getPageInformation, getResultSpecification, getSortString, isLimitResultSet, isLimitResultSetAvodingDuplicates, putParameter, putParametersForSearch, putParametersForSearch, setLanguageCode, setLimitResultSet, setLimitResultSetAvodingDuplicates, setResultSpecification, validateLong

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_EXCLUDE_ASSIGNED_TO_BLOG_ID

public static final String PARAM_EXCLUDE_ASSIGNED_TO_BLOG_ID

Query Parameter name for the blog to exclude the members from.

See Also:

Constant Field Values

PARAM_EXCLUDE_ENTITY_ID

public static final String PARAM_EXCLUDE_ENTITY_ID

Exclude this entity.

See Also:

Constant Field Values

PARAM_MEMBERSHIP_GROUP_ID

public static final String PARAM_MEMBERSHIP_GROUP_ID

Parameter for restricting the result to users and groups that are direct members of a group

See Also:

Constant Field Values

Constructor Detail

CommunoteEntityQueryParameters

public CommunoteEntityQueryParameters()

Method Detail

getExcludedAssignedToBlogId

public Long getExcludedAssignedToBlogId()

Returns:

the excludedAssignedToBlogId

getExcludedEntityId

public Long getExcludedEntityId()

Returns:

the excludedEntityId

getParameters

public Map<String,Object> getParameters()

Get the parameters of this instances, the names are the keys

Overrides:

getParameters in class UserQueryParameters

Returns:

The parameters

isDirectGroupMembership

public boolean isDirectGroupMembership()

Returns:

true if a group ID was set to restrict the result to those users and groups that are members of a group

See Also:

setDirectGroupMembershipFilteringGroupId(Long)

needTransformListItem

public boolean needTransformListItem()

Overrides:

needTransformListItem in class UserQueryParameters

Returns:

true if the transform list item function should be used after retrieving the objects

setDirectGroupMembershipFilteringGroupId

public void setDirectGroupMembershipFilteringGroupId(Long groupId)

Set the ID of a group to restrict the result to those users and groups that are direct members of that group.

Parameters:

groupId - the ID of the group

setExcludedAssignedToBlogId

public void setExcludedAssignedToBlogId(Long excludedAssignedToBlogId)

Set an ID of a topic to exclude all Communote entities from the result set which are already a member of that topic

Parameters:

excludedAssignedToBlogId - the ID of the topic

setExcludedEntityId

public void setExcludedEntityId(Long excludedEntityId)

Parameters:

excludedEntityId - the excludedEntityId to set