com.communote.server.core.vo.query.blog

Class BlogMemberManagementQueryParameters

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.blog.BlogMemberManagementQueryParameters

public class BlogMemberManagementQueryParameters
extends UserQueryParameters

Query instance to retrieve the blog member roles for a blog

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_BLOG_ID Parameter name of the blog id
static String	PARAM_EXTENRAL_SYSTEM_ID

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

Method Summary

Modifier and Type	Method and Description
Long	getBlogId()
String	getExternalSystemId()
BlogRole[]	getIncludeBlogRoles()
Map<String,Object>	getParameters() Get the parameters of this instances, the names are the keys
boolean	needTransformListItem()
void	setBlogId(Long blogId)
void	setExternalSystemId(String externalSystemId)
void	setIncludeBlogRoles(BlogRole[] includeBlogRoles)
IdentifiableEntityData	transformResultItem(Object resultItem) transform the list item after it has been loaded and filled by the query definition

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

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_BLOG_ID

public static final String PARAM_BLOG_ID

Parameter name of the blog id

See Also:

Constant Field Values

PARAM_EXTENRAL_SYSTEM_ID

public static final String PARAM_EXTENRAL_SYSTEM_ID

See Also:

Constant Field Values

Constructor Detail

BlogMemberManagementQueryParameters

public BlogMemberManagementQueryParameters()

Method Detail

getBlogId

public Long getBlogId()

Returns:

the blogId

getExternalSystemId

public String getExternalSystemId()

getIncludeBlogRoles

public BlogRole[] getIncludeBlogRoles()

Returns:

the includeBlogRoles

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

needTransformListItem

public boolean needTransformListItem()

Overrides:

needTransformListItem in class UserQueryParameters

Returns:

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

setBlogId

public void setBlogId(Long blogId)

Parameters:

blogId - the blogId to set

setExternalSystemId

public void setExternalSystemId(String externalSystemId)

setIncludeBlogRoles

public void setIncludeBlogRoles(BlogRole[] includeBlogRoles)

Parameters:

includeBlogRoles - the includeBlogRoles to set

transformResultItem

public IdentifiableEntityData transformResultItem(Object resultItem)

transform the list item after it has been loaded and filled by the query definition

Overrides:

transformResultItem in class UserQueryParameters

Parameters:

resultItem - the item to transform

Returns:

the transformed list item