java.lang.Object
- com.hybris.cockpitng.dataaccess.facades.type.DataAttribute

```
public class DataAttribute
extends java.lang.Object
```
A class holding meta information about an attribute. See DataType for further information.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DataAttribute.AttributeType`	Enumeration for the different types of attributes.
`static class`	`DataAttribute.Builder`	Builder for `DataAttribute`.
`static class`	`DataAttribute.MapType`	Map key and value type information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Map<java.util.Locale,java.lang.String>`	`getAllDescriptions()`
`java.util.Map<java.util.Locale,java.lang.String>`	`getAllLabels()`	Returns all labels for this attribute.
`DataAttribute.AttributeType`	`getAttributeType()`
`java.lang.Object`	`getDefaultValue()`
`DataType`	`getDefinedType()`
`java.lang.String`	`getDescription(java.util.Locale locale)`
`java.lang.String`	`getLabel(java.util.Locale locale)`
`DataAttribute.MapType`	`getMapType()`
`java.lang.String`	`getQualifier()`
`java.lang.String`	`getSelectionOf()`
`DataType`	`getValueType()`
`boolean`	`isEncrypted()`
`boolean`	`isLocalized()`
`boolean`	`isMandatory()`
`boolean`	`isOrdered()`
`boolean`	`isPartOf()`
`boolean`	`isPrimitive()`
`boolean`	`isSearchable()`
`boolean`	`isUnique()`
`boolean`	`isVariantAttribute()`
`boolean`	`isWritable()`
`boolean`	`isWritableOnCreation()`
`boolean`	`isWriteThrough()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - isSearchable
```
public boolean isSearchable()
```
    Returns:
    
    whether search can be performed against this attribute
  - isMandatory
```
public boolean isMandatory()
```
    Returns:
    
    true, if this attribute must have a non-null value.
  - getQualifier
```
public java.lang.String getQualifier()
```
    Returns:
    
    the qualifier of this attribute.
  - isUnique
```
public boolean isUnique()
```
    Returns:
    
    true, if this attribute is unique.
  - getDefinedType
```
public DataType getDefinedType()
```
    Returns:
    
    actual attribute's type definition
    
    See Also:
    
    getValueType()
  - getValueType
```
public DataType getValueType()
```
    Returns:
    
    element type, if attribute is collection, value type if attribute is map or defined type otherwise
  - isLocalized
```
public boolean isLocalized()
```
    Returns:
    
    true, if this attribute is localized, i.e. it's value could be something like a Map with keytype Locale.
  - isWritable
```
public boolean isWritable()
```
    Returns:
    
    true, if this attribute is writable.
  - isWritableOnCreation
```
public boolean isWritableOnCreation()
```
    Returns:
    
    true, if this attribute is writable on creation, e.g. it could be in general not writable but is mandatory. So one can set it only once.
  - isOrdered
```
public boolean isOrdered()
```
    Returns:
    
    true, if this attribute is ordered, e.g. in case of Collection, when elements order can be changed
  - isVariantAttribute
```
public boolean isVariantAttribute()
```
    Returns:
    
    true if the attribute is a variant attribute, defaults to false and all type systems that do not provide variant attributes should return the default value
  - getAttributeType
```
public DataAttribute.AttributeType getAttributeType()
```
    Returns:
    
    additional information for this attribute wrapped in an instance of DataAttribute.AttributeType.
  - getMapType
```
public DataAttribute.MapType getMapType()
```
    Returns:
    
    the DataAttribute.MapType for this attribute, if it is of type DataAttribute.AttributeType.MAP or null otherwise.
  - getLabel
```
public java.lang.String getLabel(java.util.Locale locale)
```
    Returns:
    
    the label for the given locale.
  - getAllLabels
```
public java.util.Map<java.util.Locale,java.lang.String> getAllLabels()
```
    Returns all labels for this attribute.
  - getAllDescriptions
```
public java.util.Map<java.util.Locale,java.lang.String> getAllDescriptions()
```
    Returns:
    
    all descriptions for this attribute.
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Returns:
    
    the description for the given locale.
  - isPartOf
```
public boolean isPartOf()
```
  - isPrimitive
```
public boolean isPrimitive()
```
  - isWriteThrough
```
public boolean isWriteThrough()
```
    Returns:
    
    true if the act of setting the attribute value may lead to a side effect of persisting the entity. For example platform's jalo attributes behave this way.
  - getSelectionOf
```
public java.lang.String getSelectionOf()
```
    Returns:
    
    the selectionOf property
  - getDefaultValue
```
public java.lang.Object getDefaultValue()
```
    Returns:
    
    the defaultValue property
  - isEncrypted
```
public boolean isEncrypted()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DataAttribute

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isSearchable

isMandatory

getQualifier

isUnique

getDefinedType

getValueType

isLocalized

isWritable

isWritableOnCreation

isOrdered

isVariantAttribute

getAttributeType

getMapType

getLabel

getAllLabels

getAllDescriptions

getDescription

isPartOf

isPrimitive

isWriteThrough

getSelectionOf

getDefaultValue

isEncrypted

toString