AttributeI (MyTISM API Documentation)

All Superinterfaces:

AttributeWithUIConfigurationI, BasicAttributeI, java.lang.Comparable<java.lang.Object>, GraphEdgeI

All Known Subinterfaces:

CBOAttributeI, InstrumentingAttributeI

All Known Implementing Classes:

AttributeWrapper, CBOAttribute, InstrumentingAttribute, ScriptedAttribute
```
public interface AttributeI
extends AttributeWithUIConfigurationI, GraphEdgeI
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`$0`
`static java.util.Set<java.lang.String>`	`ALLOWED_RELATION_TYPES`
`static java.lang.String`	`ATT_NAME_BACKNAME`
`static java.lang.String`	`ATT_NAME_CUSTOM_ITERATOR`
`static java.lang.String`	`ATT_NAME_CUSTOM_ITERATOR_NOT_CACHING`
`static java.lang.String`	`ATT_NAME_DB_COPY_POLICY`
`static java.lang.String`	`ATT_NAME_DB_INDEX_TYPE`
`static java.lang.String`	`ATT_NAME_DB_INDEXED`
`static java.lang.String`	`ATT_NAME_DB_RELATION_DISCRIMINATOR`
`static java.lang.String`	`ATT_NAME_DB_UNIQUE`
`static java.lang.String`	`ATT_NAME_DEFAULT`
`static java.lang.String`	`ATT_NAME_DEPENDENT`
`static java.lang.String`	`ATT_NAME_DISPLAY_FORMAT`
`static java.lang.String`	`ATT_NAME_EXPORT_DEPENDENT_PRIMARY_KEY`
`static java.lang.String`	`ATT_NAME_EXPORT_FOR`
`static java.lang.String`	`ATT_NAME_EXPORT_IGNORE_FOR`
`static java.lang.String`	`ATT_NAME_EXPORT_SEPARATE_FILE_IN`
`static java.lang.String`	`ATT_NAME_FULLTEXT_ANALYZED`
`static java.lang.String`	`ATT_NAME_FULLTEXT_ANALYZER`
`static java.lang.String`	`ATT_NAME_FULLTEXT_BOOST`
`static java.lang.String`	`ATT_NAME_FULLTEXT_INDEXED`
`static java.lang.String`	`ATT_NAME_IGNORE_BACK_RELATION`
`static java.lang.String`	`ATT_NAME_ITEM_PROPERTY`
`static java.lang.String`	`ATT_NAME_LAZY`
`static java.lang.String`	`ATT_NAME_LOOKUP_CASE_SENSITIVE`
`static java.lang.String`	`ATT_NAME_LOOKUP_PROPERTY`
`static java.lang.String`	`ATT_NAME_LOOKUP_STARTING_WITH`
`static java.lang.String`	`ATT_NAME_LOOKUP_SUBSTRING`
`static java.lang.String`	`ATT_NAME_NAME`
`static java.lang.String`	`ATT_NAME_NP_CALCULATION_AUTHORITY`
`static java.lang.String`	`ATT_NAME_OMIT_ON_COPY`
`static java.lang.String`	`ATT_NAME_READONLY`
`static java.lang.String`	`ATT_NAME_RELATION`
`static java.lang.String`	`ATT_NAME_REPORT_ALIAS`
`static java.lang.String`	`ATT_NAME_REPORT_MANY_SORT`
`static java.lang.String`	`ATT_NAME_REPORT_POSITION`
`static java.lang.String`	`ATT_NAME_REPORT_RELATIVE_WIDTH`
`static java.lang.String`	`ATT_NAME_REPORT_SORT`
`static java.lang.String`	`ATT_NAME_REPORT_VISIBLE`
`static java.lang.String`	`ATT_NAME_SHARED`
`static java.lang.String`	`ATT_NAME_SINGULAR`
`static java.lang.String`	`ATT_NAME_TYPE`
`static java.lang.String`	`ATT_NAME_UI_AUTO_TRIM`
`static java.lang.String`	`ATT_NAME_UI_CREATE_IN_DETAILVIEW`
`static java.lang.String`	`ATT_NAME_UI_EDIT_MODE`
`static java.lang.String`	`ATT_NAME_UI_EDITABLE`
`static java.lang.String`	`ATT_NAME_UI_EXPECTED_WIDTH`
`static java.lang.String`	`ATT_NAME_UI_MANDATORY`
`static java.lang.String`	`ATT_NAME_UI_SELECTION_FILTER`
`static java.lang.String`	`ATT_NAME_UI_TIPS`
`static java.lang.String`	`ATT_NAME_UI_TIPS_TRISTATE`
`static java.lang.String`	`ATT_NAME_UI_VISIBLE`
`static java.lang.String`	`ATT_NAME_VIRTUAL_AGGREGATE`
`static java.lang.String`	`ATT_NAME_VIRTUAL_AGGREGATE_IGNORE_DELETED`
`static java.lang.String`	`ATT_NAME_VIRTUAL_CACHE_MODE`
`static java.lang.String`	`ATT_NAME_VIRTUAL_INITIALDATA`
`static java.lang.String`	`ATT_NAME_VIRTUAL_PRECACHING_HOOK`
`static int`	`CACHEMODE_NONE`
`static int`	`CACHEMODE_SIMPLE`
`static java.lang.String`	`CACHEMODE_STRING_SIMPLE`
`static java.lang.String`	`CACHEMODE_STRING_VERSIONED`
`static int`	`CACHEMODE_VERSIONED`
`static int`	`CALCULATION_AUTHORITY_CLIENT`
`static int`	`CALCULATION_AUTHORITY_NONE`
`static int`	`CALCULATION_AUTHORITY_SERVER`
`static java.lang.String`	`CALCULATION_AUTHORITY_STRING_CLIENT`
`static java.lang.String`	`CALCULATION_AUTHORITY_STRING_SERVER`
`static int`	`COPY_POLICY_COPY`
`static int`	`COPY_POLICY_NONE`
`static java.lang.String`	`COPY_POLICY_STRING_COPY`
`static java.lang.String`	`COPY_POLICY_STRING_UPDATE_REL`
`static int`	`COPY_POLICY_UPDATEREL`
`static int`	`DEFAULT_EXPECTED_WIDTH`
`static int`	`EDITMODE_LINKONLY`
`static int`	`EDITMODE_UNDEFINED`
`static int`	`EDITMODE_VIEWONLY`
`static java.lang.String`	`EL_NAME_BACK_RELATION`
`static java.lang.String`	`EL_NAME_COMMENT`
`static java.lang.String`	`EL_NAME_DB`
`static java.lang.String`	`EL_NAME_EXPORT`
`static java.lang.String`	`EL_NAME_FULLTEXT`
`static java.lang.String`	`EL_NAME_LOOKUP`
`static java.lang.String`	`EL_NAME_NP`
`static java.lang.String`	`EL_NAME_REPORT`
`static java.lang.String`	`EL_NAME_UI`
`static java.lang.String`	`EL_NAME_VIRTUAL`
`static AttributeI[]`	`EMPTY_ARRAY`
`static java.lang.String`	`EXPORT_IGNORE_FOR_ALL`
`static int`	`MAX_RELATION_DISCRIMINATOR`
`static int`	`MIN_RELATION_DISCRIMINATOR`
`static int`	`NO_RELATION_DISCRIMINATOR`
`static int`	`READONLY_NO`
`static int`	`READONLY_SERVERONLY`
`static int`	`READONLY_UNDEFINED`
`static int`	`READONLY_WRITENEW`
`static java.lang.String`	`READONLY_WRITENEW_STR`
`static int`	`READONLY_YES`
`static java.lang.String`	`REPORT_SORT_ASC`
`static java.lang.String`	`REPORT_SORT_DESC`
`static java.util.Set<java.lang.String>`	`RESERVED_KEYWORDS`
`static java.util.Set<java.lang.String>`	`RESERVED_TABLE_NAMES`
`static java.lang.String`	`TYPE_NAME_DEFAULT`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object value)`
`void`	`addRelationObject(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`java.lang.Boolean`	`getAnalyzedForFTS()`
`AttributeI`	`getBackAttribute()`
`int`	`getCalculationAuthority()` Returns the calculation authority of this `AttributeI` if it is non-persistent.
`default java.lang.String`	`getContainingElementName()`
`int`	`getCopyPolicy()`
`java.lang.String`	`getEntityName()`
`int`	`getExpectedWidth()`
`java.lang.String`	`getExportDependentPrimaryKey()` Returns the attribute name of the primary key when exporting this AttributeI as a dependent relation, if any.
`OnlyToDirectedGraphNodeI`	`getFromNode()`
`java.lang.String`	`getFTSAnalyzer()`
`java.lang.Float`	`getFTSBoost()`
`java.lang.String`	`getGuiTip(java.lang.String tip)`
`int`	`getGuiTipAsInt(java.lang.String tip)`
`java.util.Map`	`getGuiTips()`
`java.lang.Boolean`	`getIndexedForFTS()`
`java.lang.String`	`getItemProperty()`
`java.lang.String`	`getL10nEntityName()`
`java.lang.String`	`getL10nName()`
`java.lang.String`	`getL10nNameKey()`
`java.lang.String`	`getL10nNameVar()`
`java.lang.String`	`getL10nSingular()`
`java.lang.String`	`getL10nSingularKey()`
`java.lang.String`	`getL10nSingularVar()`
`java.lang.Boolean`	`getLookupCaseSensitive()`
`java.lang.String`	`getLookupProperty()`
`java.lang.Boolean`	`getLookupStartingWith()`
`java.lang.Boolean`	`getLookupSubstring()`
`default java.lang.String`	`getQName()`
`default java.lang.String`	`getQName(BOI bo)`
`java.util.Iterator`	`getRelationIterator(java.lang.Object bo)`
`java.util.Map`	`getRelationObjects(java.lang.Object bo)`
`java.lang.String`	`getReportAlias()` If a report alias is given, this is the sign for us to generate a group in the report and show the data of this many-relation.
`java.lang.String`	`getReportManySort()`
`java.lang.Integer`	`getReportPosition()` Returns the expected position of the attribute in the automatic reports.
`int`	`getReportRelativeWidth()` Return the relative width of the attribute in the automatic reports, defaults to 1.
`java.lang.String`	`getReportSort()`
`java.lang.String`	`getSelectionFilter()` Returns a filter-clause that acts as a non-interactive filter within a query.
`java.lang.String`	`getTimeZoneProperty()`
`OnlyToDirectedGraphNodeI`	`getToNode()`
`default java.lang.String`	`getTypedQName()`
`default java.lang.String`	`getTypedQName(BOI bo)`
`java.lang.Object`	`getValue(java.lang.Object bo)`
`java.lang.String`	`getValueAsString(java.lang.Object bo)`
`java.lang.Object`	`getValueLazy(java.lang.Object bo)`
`boolean`	`hasGuiTip(java.lang.String tip)`
`boolean`	`hasRelationObject(java.lang.Object bo, java.lang.Object value)`
`boolean`	`isAutotrim()`
`boolean`	`isCached()`
`boolean`	`isCreateInDetailView()`
`boolean`	`isCustomIteratorNotCaching()` Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally and the relation shall be refreshed, i.e. the iterator shall run again to fill and refresh the relation.
`boolean`	`isDepend()`
`boolean`	`isEditable()` Returns if the `AttributeI` is editable in the UI.
`boolean`	`isEditable(BOI bo)` Returns if the `AttributeI` is editable in the UI for the specified `BOI`.
`boolean`	`isForExport(java.lang.String exportName)` Returns true if the vattr was marked as to export for the export with the passed name.
`boolean`	`isIgnoreBackRelation()`
`boolean`	`isIgnoredForExport(java.lang.String exportName)` Returns true if the attr was marked as to ignore during export for the export with the passed name.
`boolean`	`isIndexed()`
`boolean`	`isInitialdata()`
`boolean`	`isLazy()`
`boolean`	`isLinkOnly()`
`boolean`	`isMandatory()` Returns whether this `AttributeI` instance is a mandatory attribute.
`boolean`	`isMandatory(BOI bo)` Returns whether this `AttributeI` instance is a mandatory attribute for the specified `BOI`.
`boolean`	`isOmitOnCopy()`
`boolean`	`isPersistent()`
`boolean`	`isPolymorphicRelation()`
`boolean`	`isReadonly(BOI bo)` Returns whether this `AttributeI` instance is read-only for the specified `BOI`.
`boolean`	`isReportVisible()`
`boolean`	`isSeparateFileForExport(java.lang.String exportName)` Returns true if the attr was marked as to export to a separate file for the export with the passed name.
`boolean`	`isSerialized()`
`default boolean`	`isServerCalculated()` Returns true if this `AttributeI` is non-persistent and its calculation authority is "server".
`boolean`	`isShared()`
`boolean`	`isViewOnly()`
`boolean`	`isVisible()` Returns whether this `AttributeI` instance is visible in the UI.
`boolean`	`isVisible(BOI bo)` Returns whether this `AttributeI` instance is visible in the UI for the specified `BOI`.
`java.lang.Object`	`pgetValue(java.lang.Object bo)`
`void`	`psetValue(java.lang.Object bo, java.lang.Object value)`
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object value)`
`void`	`removeRelationObject(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`void`	`setValue(java.lang.Object bo, java.lang.Object value)`
`void`	`setValue(java.lang.Object bo, java.lang.Object value, WriteConstraintsOverriderI overrider)`
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value)`
`void`	`setValueAsString(java.lang.Object bo, java.lang.String value, boolean checkConstraints)`
`static java.lang.String`	`toAttributePath(AttributeI[] attributes)` Creates an attribute path string from an array of AttributeI.
`default java.lang.String`	`toNiceString()` Deprecated. use $`getQName()` instead

Methods inherited from interface de.ipcon.schema.AttributeWithUIConfigurationI
getEditmode, setAutotrim, setCreateInDetailView, setEditable, setEditmode, setExpectedWidth, setGuiTips, setItemProperty, setMandatory, setSelectionFilter, setTimeZoneProperty, setVisible

Methods inherited from interface de.ipcon.schema.BasicAttributeI
getClazz, getComment, getContainingElementPackage, getName, getRelationEntity, getRelationType, getSingular, getType, getTypeName, hasCustomIterator, isArray, isManyRelation, isReadonly, isRelation, isVirtual

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - $0
```
static final java.lang.String $0
```
    See Also:
    
    Constant Field Values
  - RESERVED_TABLE_NAMES
```
static final java.util.Set<java.lang.String> RESERVED_TABLE_NAMES
```
  - RESERVED_KEYWORDS
```
static final java.util.Set<java.lang.String> RESERVED_KEYWORDS
```
  - ALLOWED_RELATION_TYPES
```
static final java.util.Set<java.lang.String> ALLOWED_RELATION_TYPES
```
  - TYPE_NAME_DEFAULT
```
static final java.lang.String TYPE_NAME_DEFAULT
```
    See Also:
    
    Constant Field Values
  - EL_NAME_UI
```
static final java.lang.String EL_NAME_UI
```
    See Also:
    
    Constant Field Values
  - EL_NAME_LOOKUP
```
static final java.lang.String EL_NAME_LOOKUP
```
    See Also:
    
    Constant Field Values
  - EL_NAME_REPORT
```
static final java.lang.String EL_NAME_REPORT
```
    See Also:
    
    Constant Field Values
  - EL_NAME_EXPORT
```
static final java.lang.String EL_NAME_EXPORT
```
    See Also:
    
    Constant Field Values
  - EL_NAME_VIRTUAL
```
static final java.lang.String EL_NAME_VIRTUAL
```
    See Also:
    
    Constant Field Values
  - EL_NAME_NP
```
static final java.lang.String EL_NAME_NP
```
    See Also:
    
    Constant Field Values
  - EL_NAME_DB
```
static final java.lang.String EL_NAME_DB
```
    See Also:
    
    Constant Field Values
  - EL_NAME_BACK_RELATION
```
static final java.lang.String EL_NAME_BACK_RELATION
```
    See Also:
    
    Constant Field Values
  - EL_NAME_COMMENT
```
static final java.lang.String EL_NAME_COMMENT
```
    See Also:
    
    Constant Field Values
  - EL_NAME_FULLTEXT
```
static final java.lang.String EL_NAME_FULLTEXT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_NAME
```
static final java.lang.String ATT_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_BACKNAME
```
static final java.lang.String ATT_NAME_BACKNAME
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_SINGULAR
```
static final java.lang.String ATT_NAME_SINGULAR
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_TYPE
```
static final java.lang.String ATT_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DISPLAY_FORMAT
```
static final java.lang.String ATT_NAME_DISPLAY_FORMAT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_RELATION
```
static final java.lang.String ATT_NAME_RELATION
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DEPENDENT
```
static final java.lang.String ATT_NAME_DEPENDENT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_ITEM_PROPERTY
```
static final java.lang.String ATT_NAME_ITEM_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_SHARED
```
static final java.lang.String ATT_NAME_SHARED
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DEFAULT
```
static final java.lang.String ATT_NAME_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_IGNORE_BACK_RELATION
```
static final java.lang.String ATT_NAME_IGNORE_BACK_RELATION
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_READONLY
```
static final java.lang.String ATT_NAME_READONLY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_LAZY
```
static final java.lang.String ATT_NAME_LAZY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_OMIT_ON_COPY
```
static final java.lang.String ATT_NAME_OMIT_ON_COPY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_CUSTOM_ITERATOR
```
static final java.lang.String ATT_NAME_CUSTOM_ITERATOR
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_CUSTOM_ITERATOR_NOT_CACHING
```
static final java.lang.String ATT_NAME_CUSTOM_ITERATOR_NOT_CACHING
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_EDIT_MODE
```
static final java.lang.String ATT_NAME_UI_EDIT_MODE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_CREATE_IN_DETAILVIEW
```
static final java.lang.String ATT_NAME_UI_CREATE_IN_DETAILVIEW
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_MANDATORY
```
static final java.lang.String ATT_NAME_UI_MANDATORY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_TIPS
```
static final java.lang.String ATT_NAME_UI_TIPS
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_VISIBLE
```
static final java.lang.String ATT_NAME_UI_VISIBLE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_EXPECTED_WIDTH
```
static final java.lang.String ATT_NAME_UI_EXPECTED_WIDTH
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_SELECTION_FILTER
```
static final java.lang.String ATT_NAME_UI_SELECTION_FILTER
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_EDITABLE
```
static final java.lang.String ATT_NAME_UI_EDITABLE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_AUTO_TRIM
```
static final java.lang.String ATT_NAME_UI_AUTO_TRIM
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_UI_TIPS_TRISTATE
```
static final java.lang.String ATT_NAME_UI_TIPS_TRISTATE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_LOOKUP_PROPERTY
```
static final java.lang.String ATT_NAME_LOOKUP_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_LOOKUP_SUBSTRING
```
static final java.lang.String ATT_NAME_LOOKUP_SUBSTRING
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_LOOKUP_STARTING_WITH
```
static final java.lang.String ATT_NAME_LOOKUP_STARTING_WITH
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_LOOKUP_CASE_SENSITIVE
```
static final java.lang.String ATT_NAME_LOOKUP_CASE_SENSITIVE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_VISIBLE
```
static final java.lang.String ATT_NAME_REPORT_VISIBLE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_RELATIVE_WIDTH
```
static final java.lang.String ATT_NAME_REPORT_RELATIVE_WIDTH
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_POSITION
```
static final java.lang.String ATT_NAME_REPORT_POSITION
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_SORT
```
static final java.lang.String ATT_NAME_REPORT_SORT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_MANY_SORT
```
static final java.lang.String ATT_NAME_REPORT_MANY_SORT
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_REPORT_ALIAS
```
static final java.lang.String ATT_NAME_REPORT_ALIAS
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_EXPORT_FOR
```
static final java.lang.String ATT_NAME_EXPORT_FOR
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_EXPORT_IGNORE_FOR
```
static final java.lang.String ATT_NAME_EXPORT_IGNORE_FOR
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_EXPORT_SEPARATE_FILE_IN
```
static final java.lang.String ATT_NAME_EXPORT_SEPARATE_FILE_IN
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_EXPORT_DEPENDENT_PRIMARY_KEY
```
static final java.lang.String ATT_NAME_EXPORT_DEPENDENT_PRIMARY_KEY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_VIRTUAL_AGGREGATE
```
static final java.lang.String ATT_NAME_VIRTUAL_AGGREGATE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_VIRTUAL_AGGREGATE_IGNORE_DELETED
```
static final java.lang.String ATT_NAME_VIRTUAL_AGGREGATE_IGNORE_DELETED
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_VIRTUAL_CACHE_MODE
```
static final java.lang.String ATT_NAME_VIRTUAL_CACHE_MODE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_VIRTUAL_PRECACHING_HOOK
```
static final java.lang.String ATT_NAME_VIRTUAL_PRECACHING_HOOK
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_VIRTUAL_INITIALDATA
```
static final java.lang.String ATT_NAME_VIRTUAL_INITIALDATA
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_NP_CALCULATION_AUTHORITY
```
static final java.lang.String ATT_NAME_NP_CALCULATION_AUTHORITY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DB_INDEXED
```
static final java.lang.String ATT_NAME_DB_INDEXED
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DB_INDEX_TYPE
```
static final java.lang.String ATT_NAME_DB_INDEX_TYPE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DB_UNIQUE
```
static final java.lang.String ATT_NAME_DB_UNIQUE
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DB_COPY_POLICY
```
static final java.lang.String ATT_NAME_DB_COPY_POLICY
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_DB_RELATION_DISCRIMINATOR
```
static final java.lang.String ATT_NAME_DB_RELATION_DISCRIMINATOR
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_FULLTEXT_INDEXED
```
static final java.lang.String ATT_NAME_FULLTEXT_INDEXED
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_FULLTEXT_ANALYZED
```
static final java.lang.String ATT_NAME_FULLTEXT_ANALYZED
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_FULLTEXT_ANALYZER
```
static final java.lang.String ATT_NAME_FULLTEXT_ANALYZER
```
    See Also:
    
    Constant Field Values
  - ATT_NAME_FULLTEXT_BOOST
```
static final java.lang.String ATT_NAME_FULLTEXT_BOOST
```
    See Also:
    
    Constant Field Values
  - EDITMODE_UNDEFINED
```
static final int EDITMODE_UNDEFINED
```
    See Also:
    
    Constant Field Values
  - EDITMODE_LINKONLY
```
static final int EDITMODE_LINKONLY
```
    See Also:
    
    Constant Field Values
  - EDITMODE_VIEWONLY
```
static final int EDITMODE_VIEWONLY
```
    See Also:
    
    Constant Field Values
  - READONLY_UNDEFINED
```
static final int READONLY_UNDEFINED
```
    See Also:
    
    Constant Field Values
  - READONLY_NO
```
static final int READONLY_NO
```
    See Also:
    
    Constant Field Values
  - READONLY_YES
```
static final int READONLY_YES
```
    See Also:
    
    Constant Field Values
  - READONLY_WRITENEW
```
static final int READONLY_WRITENEW
```
    See Also:
    
    Constant Field Values
  - READONLY_WRITENEW_STR
```
static final java.lang.String READONLY_WRITENEW_STR
```
    See Also:
    
    Constant Field Values
  - READONLY_SERVERONLY
```
static final int READONLY_SERVERONLY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EXPECTED_WIDTH
```
static final int DEFAULT_EXPECTED_WIDTH
```
    See Also:
    
    Constant Field Values
  - REPORT_SORT_ASC
```
static final java.lang.String REPORT_SORT_ASC
```
    See Also:
    
    Constant Field Values
  - REPORT_SORT_DESC
```
static final java.lang.String REPORT_SORT_DESC
```
    See Also:
    
    Constant Field Values
  - CACHEMODE_NONE
```
static final int CACHEMODE_NONE
```
    See Also:
    
    Constant Field Values
  - CACHEMODE_VERSIONED
```
static final int CACHEMODE_VERSIONED
```
    See Also:
    
    Constant Field Values
  - CACHEMODE_SIMPLE
```
static final int CACHEMODE_SIMPLE
```
    See Also:
    
    Constant Field Values
  - CACHEMODE_STRING_VERSIONED
```
static final java.lang.String CACHEMODE_STRING_VERSIONED
```
    See Also:
    
    Constant Field Values
  - CACHEMODE_STRING_SIMPLE
```
static final java.lang.String CACHEMODE_STRING_SIMPLE
```
    See Also:
    
    Constant Field Values
  - CALCULATION_AUTHORITY_NONE
```
static final int CALCULATION_AUTHORITY_NONE
```
    See Also:
    
    Constant Field Values
  - CALCULATION_AUTHORITY_CLIENT
```
static final int CALCULATION_AUTHORITY_CLIENT
```
    See Also:
    
    Constant Field Values
  - CALCULATION_AUTHORITY_SERVER
```
static final int CALCULATION_AUTHORITY_SERVER
```
    See Also:
    
    Constant Field Values
  - CALCULATION_AUTHORITY_STRING_CLIENT
```
static final java.lang.String CALCULATION_AUTHORITY_STRING_CLIENT
```
    See Also:
    
    Constant Field Values
  - CALCULATION_AUTHORITY_STRING_SERVER
```
static final java.lang.String CALCULATION_AUTHORITY_STRING_SERVER
```
    See Also:
    
    Constant Field Values
  - NO_RELATION_DISCRIMINATOR
```
static final int NO_RELATION_DISCRIMINATOR
```
    See Also:
    
    Constant Field Values
  - MIN_RELATION_DISCRIMINATOR
```
static final int MIN_RELATION_DISCRIMINATOR
```
    See Also:
    
    Constant Field Values
  - MAX_RELATION_DISCRIMINATOR
```
static final int MAX_RELATION_DISCRIMINATOR
```
    See Also:
    
    Constant Field Values
  - COPY_POLICY_NONE
```
static final int COPY_POLICY_NONE
```
    See Also:
    
    Constant Field Values
  - COPY_POLICY_COPY
```
static final int COPY_POLICY_COPY
```
    See Also:
    
    Constant Field Values
  - COPY_POLICY_UPDATEREL
```
static final int COPY_POLICY_UPDATEREL
```
    See Also:
    
    Constant Field Values
  - COPY_POLICY_STRING_COPY
```
static final java.lang.String COPY_POLICY_STRING_COPY
```
    See Also:
    
    Constant Field Values
  - COPY_POLICY_STRING_UPDATE_REL
```
static final java.lang.String COPY_POLICY_STRING_UPDATE_REL
```
    See Also:
    
    Constant Field Values
  - EXPORT_IGNORE_FOR_ALL
```
static final java.lang.String EXPORT_IGNORE_FOR_ALL
```
    See Also:
    
    Constant Field Values
  - EMPTY_ARRAY
```
static final AttributeI[] EMPTY_ARRAY
```
- Method Detail
  - toAttributePath
```
static java.lang.String toAttributePath(AttributeI[] attributes)
```
    Creates an attribute path string from an array of AttributeI.
    
    Parameters:
    
    attributes - The array of AttributeI, must not be null.
    
    Returns:
    
    The attribute path string (e.g., "Ansprechpartner.Geschlecht.Name").
  - getContainingElementName
```
default java.lang.String getContainingElementName()
```
    Specified by:
    
    getContainingElementName in interface BasicAttributeI
  - getEntityName
```
java.lang.String getEntityName()
```
  - getQName
```
default java.lang.String getQName()
```
  - getQName
```
default java.lang.String getQName(BOI bo)
```
  - getTypedQName
```
default java.lang.String getTypedQName()
```
  - getTypedQName
```
default java.lang.String getTypedQName(BOI bo)
```
  - isSerialized
```
boolean isSerialized()
```
  - isPersistent
```
boolean isPersistent()
```
  - isIgnoreBackRelation
```
boolean isIgnoreBackRelation()
```
  - getCalculationAuthority
```
int getCalculationAuthority()
```
    Returns the calculation authority of this AttributeI if it is non-persistent. If this AttributeI is persistent, AttributeI.CALCULATION_AUTHORITY_NONE will always be returned.
    
    Returns:
    
    the calculation authority of this AttributeI
  - isServerCalculated
```
default boolean isServerCalculated()
```
    Returns true if this AttributeI is non-persistent and its calculation authority is "server".
    
    Returns:
    
    true if this AttributeI is non-persistent and its calculation authority is "server".
  - toNiceString
```
@Deprecated
default java.lang.String toNiceString()
```
    Deprecated. use $getQName() instead
    
    Returns the qualified name of this AttributeI.
    
    Returns:
    
    the qualified name of this AttributeI
  - isCached
```
boolean isCached()
```
  - isIndexed
```
boolean isIndexed()
```
  - isInitialdata
```
boolean isInitialdata()
```
  - getL10nNameKey
```
java.lang.String getL10nNameKey()
```
  - getL10nNameVar
```
java.lang.String getL10nNameVar()
```
  - getL10nName
```
java.lang.String getL10nName()
```
  - getL10nSingularKey
```
java.lang.String getL10nSingularKey()
```
  - getL10nSingularVar
```
java.lang.String getL10nSingularVar()
```
  - getL10nSingular
```
java.lang.String getL10nSingular()
```
  - getL10nEntityName
```
java.lang.String getL10nEntityName()
```
  - getBackAttribute
```
AttributeI getBackAttribute()
```
  - isLazy
```
boolean isLazy()
```
  - isCustomIteratorNotCaching
```
boolean isCustomIteratorNotCaching()
```
    Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally and the relation shall be refreshed, i.e. the iterator shall run again to fill and refresh the relation. The default is false, so the values are cached forever, which is useful as custom iterators are typically used in situations where a long running calculation shall only be done once and for new results, a new instance must be used.
  - isDepend
```
boolean isDepend()
```
  - isPolymorphicRelation
```
boolean isPolymorphicRelation()
```
  - getSelectionFilter
```
java.lang.String getSelectionFilter()
```
    Returns a filter-clause that acts as a non-interactive filter within a query. If this AttributeI is used as a property, this filter is automatically active and restricts the selection.
    
    Specified by:
    
    getSelectionFilter in interface AttributeWithUIConfigurationI
    
    Returns:
    
    the filter-clause for this AttributeI
  - isForExport
```
boolean isForExport(java.lang.String exportName)
```
    Returns true if the vattr was marked as to export for the export with the passed name.
  - isIgnoredForExport
```
boolean isIgnoredForExport(java.lang.String exportName)
```
    Returns true if the attr was marked as to ignore during export for the export with the passed name.
  - isSeparateFileForExport
```
boolean isSeparateFileForExport(java.lang.String exportName)
```
    Returns true if the attr was marked as to export to a separate file for the export with the passed name.
  - getExportDependentPrimaryKey
```
java.lang.String getExportDependentPrimaryKey()
```
    Returns the attribute name of the primary key when exporting this AttributeI as a dependent relation, if any.
  - getItemProperty
```
java.lang.String getItemProperty()
```
    Specified by:
    
    getItemProperty in interface AttributeWithUIConfigurationI
  - getTimeZoneProperty
```
java.lang.String getTimeZoneProperty()
```
    Specified by:
    
    getTimeZoneProperty in interface AttributeWithUIConfigurationI
  - isCreateInDetailView
```
boolean isCreateInDetailView()
```
    Specified by:
    
    isCreateInDetailView in interface AttributeWithUIConfigurationI
  - getExpectedWidth
```
int getExpectedWidth()
```
    Specified by:
    
    getExpectedWidth in interface AttributeWithUIConfigurationI
  - isShared
```
boolean isShared()
```
  - isLinkOnly
```
boolean isLinkOnly()
```
  - isViewOnly
```
boolean isViewOnly()
```
  - isOmitOnCopy
```
boolean isOmitOnCopy()
```
  - isAutotrim
```
boolean isAutotrim()
```
    Specified by:
    
    isAutotrim in interface AttributeWithUIConfigurationI
  - hasGuiTip
```
boolean hasGuiTip(java.lang.String tip)
```
  - getGuiTip
```
java.lang.String getGuiTip(java.lang.String tip)
```
  - getGuiTipAsInt
```
int getGuiTipAsInt(java.lang.String tip)
```
  - getGuiTips
```
java.util.Map getGuiTips()
```
    Specified by:
    
    getGuiTips in interface AttributeWithUIConfigurationI
  - isMandatory
```
boolean isMandatory()
```
    Returns whether this AttributeI instance is a mandatory attribute.
    
    Specified by:
    
    isMandatory in interface AttributeWithUIConfigurationI
    
    Returns:
    
    true if this AttributeI instance is a mandatory attribute.
  - isMandatory
```
boolean isMandatory(BOI bo)
```
    Returns whether this AttributeI instance is a mandatory attribute for the specified BOI.
    
    Returns:
    
    true if this AttributeI instance is a mandatory attribute for the specified BOI.
  - isReadonly
```
boolean isReadonly(BOI bo)
```
    Returns whether this AttributeI instance is read-only for the specified BOI. An attribute that is read-only for a particular BOI cannot be modified for that BOI only. If this method returns true, any attempt to modify the attribute for the specified BOI will result in an exception being thrown.
    
    Parameters:
    
    bo - the BOI for which to check the read-only status of this attribute.
    
    Returns:
    
    true if this AttributeI is read-only for the specified BOI, false otherwise.
  - isVisible
```
boolean isVisible()
```
    Returns whether this AttributeI instance is visible in the UI.
    
    Specified by:
    
    isVisible in interface AttributeWithUIConfigurationI
    
    Returns:
    
    true if this AttributeI instance is visible in the UI.
  - isVisible
```
boolean isVisible(BOI bo)
```
    Returns whether this AttributeI instance is visible in the UI for the specified BOI.
    
    Returns:
    
    true if this AttributeI instance is visible in the UI for the specified BOI.
  - isEditable
```
boolean isEditable()
```
    Returns if the AttributeI is editable in the UI.
    
    Returns:
    
    true if this AttributeI is editable in the UI.
  - isEditable
```
boolean isEditable(BOI bo)
```
    Returns if the AttributeI is editable in the UI for the specified BOI.
    
    Returns:
    
    true if this AttributeI is editable in the UI for the specified BOI.
  - getCopyPolicy
```
int getCopyPolicy()
```
  - getLookupProperty
```
java.lang.String getLookupProperty()
```
  - getLookupSubstring
```
java.lang.Boolean getLookupSubstring()
```
  - getLookupStartingWith
```
java.lang.Boolean getLookupStartingWith()
```
  - getLookupCaseSensitive
```
java.lang.Boolean getLookupCaseSensitive()
```
  - getValue
```
java.lang.Object getValue(java.lang.Object bo)
```
  - getValueLazy
```
java.lang.Object getValueLazy(java.lang.Object bo)
```
  - getValueAsString
```
java.lang.String getValueAsString(java.lang.Object bo)
```
  - setValue
```
void setValue(java.lang.Object bo,
              java.lang.Object value,
              WriteConstraintsOverriderI overrider)
```
  - setValue
```
void setValue(java.lang.Object bo,
              java.lang.Object value)
```
  - setValueAsString
```
void setValueAsString(java.lang.Object bo,
                      java.lang.String value,
                      boolean checkConstraints)
```
  - setValueAsString
```
void setValueAsString(java.lang.Object bo,
                      java.lang.String value)
```
  - getRelationIterator
```
java.util.Iterator getRelationIterator(java.lang.Object bo)
```
  - getRelationObjects
```
java.util.Map getRelationObjects(java.lang.Object bo)
```
  - addRelationObject
```
void addRelationObject(java.lang.Object bo,
                       java.lang.Object value,
                       WriteConstraintsOverriderI overrider)
```
  - addRelationObject
```
void addRelationObject(java.lang.Object bo,
                       java.lang.Object value)
```
  - removeRelationObject
```
void removeRelationObject(java.lang.Object bo,
                          java.lang.Object value,
                          WriteConstraintsOverriderI overrider)
```
  - removeRelationObject
```
void removeRelationObject(java.lang.Object bo,
                          java.lang.Object value)
```
  - hasRelationObject
```
boolean hasRelationObject(java.lang.Object bo,
                          java.lang.Object value)
```
  - pgetValue
```
java.lang.Object pgetValue(java.lang.Object bo)
```
  - psetValue
```
void psetValue(java.lang.Object bo,
               java.lang.Object value)
```
  - getIndexedForFTS
```
java.lang.Boolean getIndexedForFTS()
```
  - getAnalyzedForFTS
```
java.lang.Boolean getAnalyzedForFTS()
```
  - getFTSAnalyzer
```
java.lang.String getFTSAnalyzer()
```
  - getFTSBoost
```
java.lang.Float getFTSBoost()
```
  - isReportVisible
```
boolean isReportVisible()
```
    Returns:
    
    true if this AttributeI shall be printed in the automatic reports, defaults to true
  - getReportRelativeWidth
```
int getReportRelativeWidth()
```
    Return the relative width of the attribute in the automatic reports, defaults to 1. If e.g. 3 is given the attribute will take three times as much space as by default. This works also for attributes of entities extending other entities and adding attributes with their own relativeWiths.
    
    Returns:
    
    the relative width of the attribute in the automatic reports, defaults to 1
  - getReportPosition
```
java.lang.Integer getReportPosition()
```
    Returns the expected position of the attribute in the automatic reports. Tip: be sure to use 'high' values, so that attributes of extending entities can 'squeeze in' between them if necessary ;-) e.g. 100, 200, 300, ...
    
    Returns:
    
    the expected position of the attribute in the automatic reports
  - getReportSort
```
java.lang.String getReportSort()
```
    Returns:
    
    the way the report-data shall be sorted "flat", e.g. "asc" or "desc"
  - getReportManySort
```
java.lang.String getReportManySort()
```
    Returns:
    
    the way the report-data shall be sorted, e.g. "Tid:A, Nummer:D"
  - getReportAlias
```
java.lang.String getReportAlias()
```
    If a report alias is given, this is the sign for us to generate a group in the report and show the data of this many-relation. FIXME: support more than one many-relation in automatic reports
    
    Returns:
    
    an alias for the first many-relation or null if non defined in the schema
  - getFromNode
```
OnlyToDirectedGraphNodeI getFromNode()
```
    Specified by:
    
    getFromNode in interface GraphEdgeI
  - getToNode
```
OnlyToDirectedGraphNodeI getToNode()
```
    Specified by:
    
    getToNode in interface GraphEdgeI

Interface AttributeI

Field Summary

Method Summary

Methods inherited from interface de.ipcon.schema.AttributeWithUIConfigurationI

Methods inherited from interface de.ipcon.schema.BasicAttributeI

Methods inherited from interface java.lang.Comparable

Field Detail

$0

RESERVED_TABLE_NAMES

RESERVED_KEYWORDS

ALLOWED_RELATION_TYPES

TYPE_NAME_DEFAULT

EL_NAME_UI

EL_NAME_LOOKUP

EL_NAME_REPORT

EL_NAME_EXPORT

EL_NAME_VIRTUAL

EL_NAME_NP

EL_NAME_DB

EL_NAME_BACK_RELATION

EL_NAME_COMMENT

EL_NAME_FULLTEXT

ATT_NAME_NAME

ATT_NAME_BACKNAME

ATT_NAME_SINGULAR

ATT_NAME_TYPE

ATT_NAME_DISPLAY_FORMAT

ATT_NAME_RELATION

ATT_NAME_DEPENDENT

ATT_NAME_ITEM_PROPERTY

ATT_NAME_SHARED

ATT_NAME_DEFAULT

ATT_NAME_IGNORE_BACK_RELATION

ATT_NAME_READONLY

ATT_NAME_LAZY

ATT_NAME_OMIT_ON_COPY

ATT_NAME_CUSTOM_ITERATOR

ATT_NAME_CUSTOM_ITERATOR_NOT_CACHING

ATT_NAME_UI_EDIT_MODE

ATT_NAME_UI_CREATE_IN_DETAILVIEW

ATT_NAME_UI_MANDATORY

ATT_NAME_UI_TIPS

ATT_NAME_UI_VISIBLE

ATT_NAME_UI_EXPECTED_WIDTH

ATT_NAME_UI_SELECTION_FILTER

ATT_NAME_UI_EDITABLE

ATT_NAME_UI_AUTO_TRIM

ATT_NAME_UI_TIPS_TRISTATE

ATT_NAME_LOOKUP_PROPERTY

ATT_NAME_LOOKUP_SUBSTRING

ATT_NAME_LOOKUP_STARTING_WITH

ATT_NAME_LOOKUP_CASE_SENSITIVE

ATT_NAME_REPORT_VISIBLE

ATT_NAME_REPORT_RELATIVE_WIDTH

ATT_NAME_REPORT_POSITION

ATT_NAME_REPORT_SORT

ATT_NAME_REPORT_MANY_SORT

ATT_NAME_REPORT_ALIAS

ATT_NAME_EXPORT_FOR

ATT_NAME_EXPORT_IGNORE_FOR

ATT_NAME_EXPORT_SEPARATE_FILE_IN

ATT_NAME_EXPORT_DEPENDENT_PRIMARY_KEY

ATT_NAME_VIRTUAL_AGGREGATE

ATT_NAME_VIRTUAL_AGGREGATE_IGNORE_DELETED

ATT_NAME_VIRTUAL_CACHE_MODE

ATT_NAME_VIRTUAL_PRECACHING_HOOK

ATT_NAME_VIRTUAL_INITIALDATA

ATT_NAME_NP_CALCULATION_AUTHORITY

ATT_NAME_DB_INDEXED

ATT_NAME_DB_INDEX_TYPE

ATT_NAME_DB_UNIQUE

ATT_NAME_DB_COPY_POLICY

ATT_NAME_DB_RELATION_DISCRIMINATOR

ATT_NAME_FULLTEXT_INDEXED

ATT_NAME_FULLTEXT_ANALYZED

ATT_NAME_FULLTEXT_ANALYZER

ATT_NAME_FULLTEXT_BOOST

EDITMODE_UNDEFINED

EDITMODE_LINKONLY

EDITMODE_VIEWONLY