com.edorasware.commons.core.query.entity

Class HiddenVariableQueryHint

java.lang.Object

com.edorasware.commons.core.query.entity.HiddenVariableQueryHint

All Implemented Interfaces:

QueryHint

public final class HiddenVariableQueryHint
extends Object
implements QueryHint

A query hint which manages the inclusion of variables which have the HIDDEN_VARIABLE_NAME_PREFIX as name prefix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIDDEN_VARIABLE_NAME_PREFIX Name prefix for variables with which the variable is treated as hidden variable and it will not be fetched by default.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HiddenVariableQueryHint(String name)

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the query hint

Methods inherited from class java.lang.Object

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

Field Detail

HIDDEN_VARIABLE_NAME_PREFIX

public static final String HIDDEN_VARIABLE_NAME_PREFIX

Name prefix for variables with which the variable is treated as hidden variable and it will not be fetched by default. If the hidden variables should be loaded the DomainObjectQuery.Hint.INCLUDE_HIDDEN_VARIABLES hint needs to be present in the query.

See Also:

Constant Field Values

Constructor Detail

HiddenVariableQueryHint

protected HiddenVariableQueryHint(String name)

Method Detail

getName

public String getName()

Description copied from interface: QueryHint

Returns the name of the query hint

Specified by:

getName in interface QueryHint

Returns:

the name of the query hint