Package de.hybris.platform.cockpit.services.search.impl

Class ItemAttributeSearchDescriptor

java.lang.Object

de.hybris.platform.cockpit.services.search.impl.ItemAttributeSearchDescriptor

All Implemented Interfaces:

PropertyDescriptor, SearchParameterDescriptor, GenericSearchParameterDescriptor

public class ItemAttributeSearchDescriptor
extends java.lang.Object
implements GenericSearchParameterDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface de.hybris.platform.cockpit.model.meta.PropertyDescriptor

PropertyDescriptor.Multiplicity, PropertyDescriptor.Occurrence

Field Summary

Fields inherited from interface de.hybris.platform.cockpit.model.meta.PropertyDescriptor

BOOLEAN, DATE, DECIMAL, ENUM, FEATURE, FLOAT, INTEGER, LONG, PK, QUALIFIER_DELIM, QUALIFIER_DELIM_EXP, REFERENCE, TEXT

Constructor Summary

Constructors

Constructor	Description
ItemAttributeSearchDescriptor(ItemAttributePropertyDescriptor propertyDescriptor)

Method Summary

Modifier and Type	Method	Description
GenericCondition	createCondition(GenericQuery query, java.lang.Object value, Operator operator)	Creates the condition for the given generic query combined of the specified arguments.
protected GenericQueryParameterCreator	createCreator()
boolean	equals(java.lang.Object obj)
java.util.List<AttributeDescriptorModel>	getAttributeDescriptors()
java.lang.String	getAttributeQualifier()	Returns the attribute qualifier of the underlying property.
Operator	getDefaultOperator()	Returns the default operator for the property, which can be "equals", "contains", etc..
java.lang.String	getDescription()	localized description
java.lang.String	getEditorType()	The general editor type.
AttributeDescriptorModel	getFirstAttributeDescriptor()
AttributeDescriptorModel	getLastAttributeDescriptor()
PropertyDescriptor.Multiplicity	getMultiplicity()	Specifies which type of collection this editor should handle.
java.lang.String	getName()	localized name
java.lang.String	getName(java.lang.String languageIso)
PropertyDescriptor.Occurrence	getOccurence()	Tells if this property is mandatory, recommended or optional.
java.util.List<Operator>	getOperators()
java.lang.String	getQualifier()	The (globally!) unique property qualifier.
protected GenericQueryParameterCreator	getQueryCreator()
ComposedTypeModel	getRequiredComposedType()	Returns the required composed type that is enclosing type of underlying property descriptor.
java.lang.String	getSelectionOf()	qualifier of property descriptor that holds the "selectionOf"
int	hashCode()
boolean	isLocalized()	Tells whether this property contains localized data.
boolean	isReadable()
boolean	isSimpleSearchProperty()	Checks if is simple search property.
boolean	isWritable()
void	setEditorType(java.lang.String type)	Deprecated. since 6.3, ItemAttributePropertyDescriptor.setEditorType(String) should be used instead.
void	setOperators(java.util.List<Operator> operators)
void	setSimpleSearchProperty(boolean simpleSearchProperty)

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemAttributeSearchDescriptor

public ItemAttributeSearchDescriptor(ItemAttributePropertyDescriptor propertyDescriptor)

Method Detail

createCreator

protected GenericQueryParameterCreator createCreator()

getQueryCreator

protected GenericQueryParameterCreator getQueryCreator()

createCondition

public GenericCondition createCondition(GenericQuery query,
                                        java.lang.Object value,
                                        Operator operator)

Description copied from interface: GenericSearchParameterDescriptor

Creates the condition for the given generic query combined of the specified arguments.

Specified by:

createCondition in interface GenericSearchParameterDescriptor

Parameters:

query - the generic query that condition will be created for

value - the value used to create condition

operator - the operator used to create condition

Returns:

the new create generic condition

getRequiredComposedType

public ComposedTypeModel getRequiredComposedType()

Description copied from interface: GenericSearchParameterDescriptor

Returns the required composed type that is enclosing type of underlying property descriptor.

Specified by:

getRequiredComposedType in interface GenericSearchParameterDescriptor

Returns:

the required composed type

isSimpleSearchProperty

public boolean isSimpleSearchProperty()

Description copied from interface: GenericSearchParameterDescriptor

Checks if is simple search property.

Specified by:

isSimpleSearchProperty in interface GenericSearchParameterDescriptor

Returns:

true, if is simple search property

setSimpleSearchProperty

public void setSimpleSearchProperty(boolean simpleSearchProperty)

setEditorType

@Deprecated
public void setEditorType(java.lang.String type)

Deprecated.

since 6.3, ItemAttributePropertyDescriptor.setEditorType(String) should be used instead.

Sets the editor type of this ItemAttributeSearchDescriptor.

Parameters:

type - the editor type to set

setOperators

public void setOperators(java.util.List<Operator> operators)

getOperators

public java.util.List<Operator> getOperators()

Specified by:

getOperators in interface SearchParameterDescriptor

getDefaultOperator

public Operator getDefaultOperator()

Description copied from interface: GenericSearchParameterDescriptor

Returns the default operator for the property, which can be "equals", "contains", etc..

Specified by:

getDefaultOperator in interface GenericSearchParameterDescriptor

Returns:

the default operator for the underlying property

getDescription

public java.lang.String getDescription()

Description copied from interface: PropertyDescriptor

localized description

Specified by:

getDescription in interface PropertyDescriptor

Returns:

localized description

getEditorType

public java.lang.String getEditorType()

Description copied from interface: PropertyDescriptor

The general editor type.

Specified by:

getEditorType in interface PropertyDescriptor

getMultiplicity

public PropertyDescriptor.Multiplicity getMultiplicity()

Description copied from interface: PropertyDescriptor

Specifies which type of collection this editor should handle. Single valued editors use PropertyDescriptor.Multiplicity.SINGLE or null.

Specified by:

getMultiplicity in interface PropertyDescriptor

getName

public java.lang.String getName()

Description copied from interface: PropertyDescriptor

localized name

Specified by:

getName in interface PropertyDescriptor

Returns:

localized name

getOccurence

public PropertyDescriptor.Occurrence getOccurence()

Description copied from interface: PropertyDescriptor

Tells if this property is mandatory, recommended or optional.

Specified by:

getOccurence in interface PropertyDescriptor

getQualifier

public java.lang.String getQualifier()

Description copied from interface: PropertyDescriptor

The (globally!) unique property qualifier.

Specified by:

getQualifier in interface PropertyDescriptor

isLocalized

public boolean isLocalized()

Description copied from interface: PropertyDescriptor

Tells whether this property contains localized data.

Specified by:

isLocalized in interface PropertyDescriptor

getAttributeQualifier

public java.lang.String getAttributeQualifier()

Description copied from interface: GenericSearchParameterDescriptor

Returns the attribute qualifier of the underlying property.

Specified by:

getAttributeQualifier in interface GenericSearchParameterDescriptor

Returns:

the attribute qualifier

getAttributeDescriptors

public java.util.List<AttributeDescriptorModel> getAttributeDescriptors()

getFirstAttributeDescriptor

public AttributeDescriptorModel getFirstAttributeDescriptor()

getLastAttributeDescriptor

public AttributeDescriptorModel getLastAttributeDescriptor()

getName

public java.lang.String getName(java.lang.String languageIso)

Specified by:

getName in interface PropertyDescriptor

isReadable

public boolean isReadable()

Specified by:

isReadable in interface PropertyDescriptor

isWritable

public boolean isWritable()

Specified by:

isWritable in interface PropertyDescriptor

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getSelectionOf

public java.lang.String getSelectionOf()

Description copied from interface: PropertyDescriptor

qualifier of property descriptor that holds the "selectionOf"

Specified by:

getSelectionOf in interface PropertyDescriptor

Returns:

qualifier of property descriptor