com.foreach.across.modules.webcms.domain.domain

Class EntityQueryWebCmsDomainFunctions

java.lang.Object

com.foreach.across.modules.webcms.domain.domain.EntityQueryWebCmsDomainFunctions

All Implemented Interfaces:

com.foreach.across.modules.entity.query.EntityQueryFunctionHandler

@Component
 @Lazy
public final class EntityQueryWebCmsDomainFunctions
extends Object
implements com.foreach.across.modules.entity.query.EntityQueryFunctionHandler

Implements support for selectedDomain(), visibleDomains() and accessibleDomains() in EQL statements. Uses the WebCmsMultiDomainAdminUiService for execution of the specific methods and will convert the result to valid EQL.

Since:

0.0.3

Author:

Arne Vandamme

See Also:

WebCmsMultiDomainAdminUiService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESSIBLE_DOMAINS Returns all domains that the current principal can see.
static String	SELECTED_DOMAIN Always returns the current domain, bound to the WebCmsDomainContextHolder.
static String	VISIBLE_DOMAINS Returns the domains from which entities are currently selectable.

Constructor Summary

Constructors

Constructor and Description
EntityQueryWebCmsDomainFunctions()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(String functionName, org.springframework.core.convert.TypeDescriptor desiredType)
Object	apply(String functionName, com.foreach.across.modules.entity.query.EQType[] arguments, org.springframework.core.convert.TypeDescriptor desiredType, com.foreach.across.modules.entity.query.EQTypeConverter argumentConverter)
static com.foreach.across.modules.entity.query.EntityQueryConditionTranslator	conditionTranslator() Create a condition translator that supports the domain-related functions and will expand single condition (eg.

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_DOMAIN

public static final String SELECTED_DOMAIN

Always returns the current domain, bound to the WebCmsDomainContextHolder. This method will return a single domain only or none.

domain = currentDomain() will be translated to either domain IS EMPTY or domain = DOMAIN_ID

See Also:

Constant Field Values

VISIBLE_DOMAINS

public static final String VISIBLE_DOMAINS

Returns the domains from which entities are currently selectable. Usually this is the current domain, however if the current multi-domain configuration allows no-domain, these will be included as well.

In short, the query domain = selectableDomains() might be translated to domain = currentDomain() or domain = currentDomain() or domain IS EMPTY depending on the multi-domain configuration.

See Also:

Constant Field Values

ACCESSIBLE_DOMAINS

public static final String ACCESSIBLE_DOMAINS

Returns all domains that the current principal can see. Optionally takes one or more string parameter that are AllowableAction that the principal should have for that domain. Note that in case of multiple parameters, it is an OR construct: as soon as the user has any of those actions allowed the domain will be included.

If no-domain is allowed, will check if the user has the permissions to manage no-domain.

See Also:

Constant Field Values

Constructor Detail

EntityQueryWebCmsDomainFunctions

public EntityQueryWebCmsDomainFunctions()

Method Detail

conditionTranslator

public static com.foreach.across.modules.entity.query.EntityQueryConditionTranslator conditionTranslator()

Create a condition translator that supports the domain-related functions and will expand single condition (eg. domain in accessibleDomains()) to multiple conditions (eg. (domain in (1,2,3) or domain IS EMPTY).

Returns:

condition translator

accepts

public boolean accepts(String functionName,
                       org.springframework.core.convert.TypeDescriptor desiredType)

Specified by:

accepts in interface com.foreach.across.modules.entity.query.EntityQueryFunctionHandler

apply

public Object apply(String functionName,
                    com.foreach.across.modules.entity.query.EQType[] arguments,
                    org.springframework.core.convert.TypeDescriptor desiredType,
                    com.foreach.across.modules.entity.query.EQTypeConverter argumentConverter)

Specified by:

apply in interface com.foreach.across.modules.entity.query.EntityQueryFunctionHandler