Package de.hybris.platform.jalo.type
Class ViewAttributeDescriptor
java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.type.TypeManagerManaged
de.hybris.platform.jalo.type.Descriptor
de.hybris.platform.jalo.type.AttributeDescriptor
de.hybris.platform.jalo.type.ViewAttributeDescriptor
- All Implemented Interfaces:
Serializable,Comparable
This attribute descriptor describes a
ViewType. It describes its value type as
well as its persistence implementation.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.AttributeDescriptor
AttributeDescriptor.AttributeDescriptorImplNested classes/interfaces inherited from class de.hybris.platform.jalo.type.Descriptor
Descriptor.DescriptorImplNested classes/interfaces inherited from class de.hybris.platform.jalo.type.TypeManagerManaged
TypeManagerManaged.TypeManagerManagedImplNested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImplNested classes/interfaces inherited from class de.hybris.platform.jalo.Item
Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException -
Field Summary
Fields inherited from class de.hybris.platform.jalo.type.AttributeDescriptor
ALL, ALL_PUBLIC, ATTRIBUTE_HANDLER, DATABASECOLUMN, DECLARING_ENCLOSING_TYPE, DEFAULTVALUE, DEFAULTVALUE_DEFINITIONSTRING, DESCRIPTION, DONT_COPY, ENCLOSING_TYPE, ENCRYPTED, ENCRYPTED_FLAG, HIDDENFORUI, INHERITED, INHERITED_FLAG, INITIAL, INITIAL_FLAG, LOCALIZED, LOCALIZED_FLAG, MODIFIERS, OPTIONAL, OPTIONAL_FLAG, PARTOF, PARTOF_FLAG, PERSISTENCE_CLASS, PERSISTENCETYPE, PRIMITIVE, PRIMITIVE_FLAG, PRIVATE, PRIVATE_FLAG, PROPERTY, PROPERTY_FLAG, PROPOSED_DATABASE_COLUMN, READ, READ_FLAG, READABLE, READONLYFORUI, REMOVABLE, REMOVE, REMOVE_FLAG, SEARCH, SEARCH_FLAG, TIM_IGNORE, TIM_IGNORE_FLAG, UNIQUE, WRITABLE, WRITE, WRITE_FLAGFields inherited from class de.hybris.platform.jalo.type.Descriptor
ATTRIBUTETYPE, QUALIFIERFields inherited from class de.hybris.platform.jalo.type.TypeManagerManaged
AUTOCREATE, DEPRECATED, EXTENSION_NAME, GENERATE, NAMEFields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLEDFields inherited from class de.hybris.platform.jalo.Item
_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPEFields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ItemcreateItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Creator method for generic creation of attribute descriptor.If the attribute is backed by a EJB CMP field this method returns the CMP field name.intprotected MapOverride to add custom properties to this type's xml definition.booleanisParam()booleanTells whether the attribute is realized as property or not.booleanTells whether a attribute is searchable or not.voidsetInitial(boolean b) no-opvoidsetLocalized(boolean b) no-opvoidsetParam(boolean isParam) voidsetPartOf(boolean b) no-opvoidsetPosition(int pos) voidsetPrivate(boolean b) no-opvoidsetProperty(boolean b) no-opvoidsetReadable(boolean b) no-opvoidsetRemovable(boolean b) no-opvoidsetSearchable(boolean b) no-opvoidsetWritable(boolean b) no-opMethods inherited from class de.hybris.platform.jalo.type.AttributeDescriptor
checkDefaultValueAssignability, checkLocalizedChange, checkPartOfChange, checkPropertyChange, checkSearchableChange, checkSelectionOfDescriptor, checkTypeChange, checkTypePermission, checkTypePermission, exportXMLDefinition, exportXMLDefinitionDefaultValue, getAllDescriptions, getAllDescriptions, getAllNames, getAllSubAttributeDescriptors, getAttributeDescriptorImpl, getAttributeHandler, getDatabaseColumn, getDeclaringEnclosingType, getDefaultValue, getDefaultValue, getDefaultValueDefinitionString, getDescription, getDescription, getDontOptimize, getEnclosingType, getIntModifiersFromMap, getModifiers, getName, getNonInitialAttributes, getPersistenceClass, getPersistenceType, getProposedDatabaseColumn, getSelectionOf, getSubAttributeDescriptors, getXMLDefinition, interpretAndReplaceDefaultValue, isEncrypted, isHiddenForUI, isInherited, isInitial, isLocalized, isOptional, isPartOf, isPrimitive, isPrivate, isReadable, isReadOnlyForUI, isRedeclared, isRemovable, isRuntime, isUnique, isWritable, isWriteable, redeclareAttributeType, removeLocalizedProperty, removeLocalizedPropertyNonRecursively, removeProperty, removePropertyNonRecursively, setAllDescriptions, setAllDescriptions, setAttributeHandler, setAttributeType, setDatabaseColumn, setDefaultValue, setDefaultValue, setDescription, setDescription, setDontOptimize, setEncrypted, setHiddenForUI, setLocalizedProperty, setLocalizedPropertyNonRecursively, setModifiers, setOptional, setPrimitive, setProperty, setPropertyNonRecursively, setReadOnlyForUI, setSelectionOf, setUnique, toString, toString, writeDefaultValueTagAtomicMethods inherited from class de.hybris.platform.jalo.type.Descriptor
compareTo, getAttributeType, getAttributeType, getContextAdjustedAttributeType, getDescriptorImpl, getQualifier, getRealAttributeTypeMethods inherited from class de.hybris.platform.jalo.type.TypeManagerManaged
getAllNames, getExtensionName, getImpl, getName, isAutocreate, isDeprecated, isGenerate, setAllNames, setAllNames, setAutocreate, setExtensionName, setGenerate, setName, setNameMethods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedPropertyMethods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getImplementation, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, setAllProperties, setAllProperties, setPropertyMethods inherited from class de.hybris.platform.jalo.Item
addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPartOfRemovedSessionMarker, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRelatedItems, getRelatedItems, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setRelatedItems, setTransientObject, setUseTA, suppressRelation, useTA, writeReplaceMethods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
Constructor Details
-
ViewAttributeDescriptor
public ViewAttributeDescriptor()
-
-
Method Details
-
createItem
protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException Description copied from class:AttributeDescriptorCreator method for generic creation of attribute descriptor. The following attributes are required:- Overrides:
createItemin classAttributeDescriptor- Parameters:
ctx- the current session context which this item is created withintype- the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )- Returns:
- the new item instance
- Throws:
JaloBusinessException- indicates an error during creation - any changes will be rollbacked
-
getPosition
public int getPosition() -
setPosition
public void setPosition(int pos) -
isParam
public boolean isParam() -
setParam
public void setParam(boolean isParam) -
isSearchable
public boolean isSearchable()Description copied from class:AttributeDescriptorTells whether a attribute is searchable or not. Usually this may only be true if the attribute has got persistence informations likeAttributeDescriptor.getDatabaseColumn()andAttributeDescriptor.getPersistenceClass().- Overrides:
isSearchablein classAttributeDescriptor- Returns:
- true is this view attribute is a param attribute, false otherwise
-
isProperty
public boolean isProperty()Description copied from class:AttributeDescriptorTells whether the attribute is realized as property or not.A attribute realized as property may always be accessed via
ExtensibleItem.getProperty(String)andExtensibleItem.setProperty(String, Object)as well as the generic way.Due to the fact that only
ExtensibleItemsubclasses can have properties the enclosing type cannot describe a jalo item which is not.- Overrides:
isPropertyin classAttributeDescriptor- See Also:
-
getPersistenceQualifier
Description copied from class:AttributeDescriptorIf the attribute is backed by a EJB CMP field this method returns the CMP field name. Otherwisenullis returned.- Overrides:
getPersistenceQualifierin classAttributeDescriptor
-
setPrivate
public void setPrivate(boolean b) no-op- Overrides:
setPrivatein classAttributeDescriptor- Parameters:
b- the new private status- See Also:
-
setProperty
public void setProperty(boolean b) no-op- Overrides:
setPropertyin classAttributeDescriptor- Parameters:
b- the new property flag status- See Also:
-
setLocalized
public void setLocalized(boolean b) no-op- Overrides:
setLocalizedin classAttributeDescriptor- Parameters:
b- the new localized status
-
setWritable
public void setWritable(boolean b) no-op- Overrides:
setWritablein classAttributeDescriptor- See Also:
-
setReadable
public void setReadable(boolean b) no-op- Overrides:
setReadablein classAttributeDescriptor- See Also:
-
setSearchable
public void setSearchable(boolean b) no-op- Overrides:
setSearchablein classAttributeDescriptor
-
setPartOf
public void setPartOf(boolean b) no-op- Overrides:
setPartOfin classAttributeDescriptor- See Also:
-
setInitial
public void setInitial(boolean b) no-op- Overrides:
setInitialin classAttributeDescriptor- Parameters:
b- the new initial flag
-
setRemovable
public void setRemovable(boolean b) no-op- Overrides:
setRemovablein classAttributeDescriptor- See Also:
-
getXMLCustomProperties
Description copied from class:AttributeDescriptorOverride to add custom properties to this type's xml definition.- Overrides:
getXMLCustomPropertiesin classAttributeDescriptor
-