com.communote.server.core.vo.query.config

Class BlogQueryParametersConfigurator<T extends BlogQueryParameters>

java.lang.Object

com.communote.server.core.vo.query.config.QueryParametersConfigurator

com.communote.server.core.vo.query.config.BlogQueryParametersConfigurator<T>

Type Parameters:

T -

public class BlogQueryParametersConfigurator<T extends BlogQueryParameters>
extends QueryParametersConfigurator

Configurator for BlogQueryParameters

Author:

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

Constructor Summary

Constructors

Constructor and Description
BlogQueryParametersConfigurator(QueryParametersParameterNameProvider parameterNameProvider) Default constructor
BlogQueryParametersConfigurator(QueryParametersParameterNameProvider parameterNameProvider, int defaultMaxCount, boolean defaultExcludeDefaultBlog) Constructor

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,?> parameters, T instance) Configures the query queryParameters
void	configure(Map<String,?> parameters, T instance, TopicAccessLevel forcedAccessLevel) Configures the query queryParameters
static void	configureForAllManagedBlogs(BlogQueryParameters instance) Helper method which configures the query queryParameters to return all managed blogs of the current user.
protected void	configureQueryInstance(Map<String,?> parameters, T queryParameters, TopicAccessLevel forcedAccessLevel) Configures the query queryParameters

Methods inherited from class com.communote.server.core.vo.query.config.QueryParametersConfigurator

getParameterNameProvider, getResultSpecification, getResultSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

BlogQueryParametersConfigurator

public BlogQueryParametersConfigurator(QueryParametersParameterNameProvider parameterNameProvider)

Default constructor

Parameters:

parameterNameProvider - the name provider to use

BlogQueryParametersConfigurator

public BlogQueryParametersConfigurator(QueryParametersParameterNameProvider parameterNameProvider,
                                       int defaultMaxCount,
                                       boolean defaultExcludeDefaultBlog)

Constructor

Parameters:

parameterNameProvider - the name provider to use

defaultMaxCount - maxCount limit to use if this parameter is not set

defaultExcludeDefaultBlog - whether to exclude the default blog when the parameter that defines the exclusion of the default blog is not set

Method Detail

configureForAllManagedBlogs

public static void configureForAllManagedBlogs(BlogQueryParameters instance)

Helper method which configures the query queryParameters to return all managed blogs of the current user.

Parameters:

instance - the queryParameters to configure

configure

public void configure(Map<String,?> parameters,
                      T instance)

Configures the query queryParameters

Parameters:

parameters - the parameters to evaluate

instance - the queryParameters to configure

configure

public void configure(Map<String,?> parameters,
                      T instance,
                      TopicAccessLevel forcedAccessLevel)

Configures the query queryParameters

Parameters:

parameters - the parameters to evaluate

instance - the queryParameters to configure

forcedAccessLevel - the blog access level to set. If this argument is set the access level parameter will be ignored.

configureQueryInstance

protected void configureQueryInstance(Map<String,?> parameters,
                                      T queryParameters,
                                      TopicAccessLevel forcedAccessLevel)

Configures the query queryParameters

Parameters:

parameters - the parameters to evaluate

queryParameters - the queryParameters to configure

forcedAccessLevel - the blog access level to set. If this argument is set the access level parameter will be ignored.