Class ClassAttributeSearchDescriptor
- java.lang.Object
-
- de.hybris.platform.cockpit.services.search.impl.ClassAttributeSearchDescriptor
-
- All Implemented Interfaces:
PropertyDescriptor,SearchParameterDescriptor,GenericSearchParameterDescriptor
public class ClassAttributeSearchDescriptor 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 ClassAttributeSearchDescriptor(ClassAttributePropertyDescriptor propertyDescriptor)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GenericConditioncreateCondition(GenericQuery query, java.lang.Object value, Operator operator)Creates the condition for the given generic query combined of the specified arguments.ClassAttributeAssignmentgetAttributeAssignment()Deprecated.since 6.3, usegetClassAttributeAssignment()insteadjava.lang.StringgetAttributeQualifier()Returns the attribute qualifier of the underlying property.ClassAttributeAssignmentModelgetClassAttributeAssignment()OperatorgetDefaultOperator()Returns the default operator for the property, which can be "equals", "contains", etc..java.lang.StringgetDescription()localized descriptionjava.lang.StringgetEditorType()The general editor type.PropertyDescriptor.MultiplicitygetMultiplicity()Specifies which type of collection this editor should handle.java.lang.StringgetName()localized namejava.lang.StringgetName(java.lang.String languageIso)PropertyDescriptor.OccurrencegetOccurence()Tells if this property is mandatory, recommended or optional.java.util.List<Operator>getOperators()ClassAttributePropertyDescriptorgetPropertyDescriptor()java.lang.StringgetQualifier()The (globally!) unique property qualifier.protected GenericQueryClassParameterCreatorgetQueryCreator()ComposedTypeModelgetRequiredComposedType()Returns the required composed type that is enclosing type of underlying property descriptor.java.lang.StringgetSelectionOf()qualifier of property descriptor that holds the "selectionOf"booleanisLocalized()Tells whether this property contains localized data.booleanisReadable()booleanisSimpleSearchProperty()Checks if is simple search property.booleanisWritable()voidsetOperators(java.util.List<Operator> operators)voidsetSimpleSearchProperty(boolean simpleSearchProperty)
-
-
-
Constructor Detail
-
ClassAttributeSearchDescriptor
public ClassAttributeSearchDescriptor(ClassAttributePropertyDescriptor propertyDescriptor)
-
-
Method Detail
-
getQueryCreator
protected GenericQueryClassParameterCreator getQueryCreator()
-
getPropertyDescriptor
public ClassAttributePropertyDescriptor getPropertyDescriptor()
-
createCondition
public GenericCondition createCondition(GenericQuery query, java.lang.Object value, Operator operator)
Description copied from interface:GenericSearchParameterDescriptorCreates the condition for the given generic query combined of the specified arguments.- Specified by:
createConditionin interfaceGenericSearchParameterDescriptor- Parameters:
query- the generic query that condition will be created forvalue- the value used to create conditionoperator- the operator used to create condition- Returns:
- the new create generic condition
-
getRequiredComposedType
public ComposedTypeModel getRequiredComposedType()
Description copied from interface:GenericSearchParameterDescriptorReturns the required composed type that is enclosing type of underlying property descriptor.- Specified by:
getRequiredComposedTypein interfaceGenericSearchParameterDescriptor- Returns:
- the required composed type
-
isSimpleSearchProperty
public boolean isSimpleSearchProperty()
Description copied from interface:GenericSearchParameterDescriptorChecks if is simple search property.- Specified by:
isSimpleSearchPropertyin interfaceGenericSearchParameterDescriptor- Returns:
- true, if is simple search property
-
setSimpleSearchProperty
public void setSimpleSearchProperty(boolean simpleSearchProperty)
-
setOperators
public void setOperators(java.util.List<Operator> operators)
-
getOperators
public java.util.List<Operator> getOperators()
- Specified by:
getOperatorsin interfaceSearchParameterDescriptor
-
getDefaultOperator
public Operator getDefaultOperator()
Description copied from interface:GenericSearchParameterDescriptorReturns the default operator for the property, which can be "equals", "contains", etc..- Specified by:
getDefaultOperatorin interfaceGenericSearchParameterDescriptor- Returns:
- the default operator for the underlying property
-
getAttributeAssignment
@Deprecated public ClassAttributeAssignment getAttributeAssignment()
Deprecated.since 6.3, usegetClassAttributeAssignment()instead
-
getClassAttributeAssignment
public ClassAttributeAssignmentModel getClassAttributeAssignment()
-
getAttributeQualifier
public java.lang.String getAttributeQualifier()
Description copied from interface:GenericSearchParameterDescriptorReturns the attribute qualifier of the underlying property.- Specified by:
getAttributeQualifierin interfaceGenericSearchParameterDescriptor- Returns:
- the attribute qualifier
-
getDescription
public java.lang.String getDescription()
Description copied from interface:PropertyDescriptorlocalized description- Specified by:
getDescriptionin interfacePropertyDescriptor- Returns:
- localized description
-
getEditorType
public java.lang.String getEditorType()
Description copied from interface:PropertyDescriptorThe general editor type.- Specified by:
getEditorTypein interfacePropertyDescriptor
-
getMultiplicity
public PropertyDescriptor.Multiplicity getMultiplicity()
Description copied from interface:PropertyDescriptorSpecifies which type of collection this editor should handle. Single valued editors usePropertyDescriptor.Multiplicity.SINGLEor null.- Specified by:
getMultiplicityin interfacePropertyDescriptor
-
getName
public java.lang.String getName()
Description copied from interface:PropertyDescriptorlocalized name- Specified by:
getNamein interfacePropertyDescriptor- Returns:
- localized name
-
getOccurence
public PropertyDescriptor.Occurrence getOccurence()
Description copied from interface:PropertyDescriptorTells if this property is mandatory, recommended or optional.- Specified by:
getOccurencein interfacePropertyDescriptor
-
getQualifier
public java.lang.String getQualifier()
Description copied from interface:PropertyDescriptorThe (globally!) unique property qualifier.- Specified by:
getQualifierin interfacePropertyDescriptor
-
isLocalized
public boolean isLocalized()
Description copied from interface:PropertyDescriptorTells whether this property contains localized data.- Specified by:
isLocalizedin interfacePropertyDescriptor
-
getName
public java.lang.String getName(java.lang.String languageIso)
- Specified by:
getNamein interfacePropertyDescriptor
-
isReadable
public boolean isReadable()
- Specified by:
isReadablein interfacePropertyDescriptor
-
isWritable
public boolean isWritable()
- Specified by:
isWritablein interfacePropertyDescriptor
-
getSelectionOf
public java.lang.String getSelectionOf()
Description copied from interface:PropertyDescriptorqualifier of property descriptor that holds the "selectionOf"- Specified by:
getSelectionOfin interfacePropertyDescriptor- Returns:
- qualifier of property descriptor
-
-