Package de.hybris.platform.jalo.type

Class TypeManagerManaged

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable
    Direct Known Subclasses:
    Descriptor, SearchRestriction, Type
    public abstract class TypeManagerManaged
extends LocalizableItem
    Base class of all type system classes.

    This class provides any type system item with a localized name and its extension name. The extension name shows which extension a type system item belongs to - means: which items.xml it should be declared in.

    See Also:
    Serialized Form

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        The name attribute string constant.
        See Also:
        Constant Field Values

      • EXTENSION_NAME

        public static final java.lang.String EXTENSION_NAME
        The extension name attribute string constant.
        See Also:
        Constant Field Values

      • DEPRECATED

        public static final java.lang.String DEPRECATED
        The deprecated attribute string constant.
        See Also:
        Constant Field Values

      • AUTOCREATE

        public static final java.lang.String AUTOCREATE
        The autocreate attribute string constant.
        See Also:
        Constant Field Values

      • GENERATE

        public static final java.lang.String GENERATE
        The generate attribute string constant.
        See Also:
        Constant Field Values

    • Constructor Detail

      • TypeManagerManaged

        public TypeManagerManaged()

    • Method Detail

      • getExtensionName

        public java.lang.String getExtensionName()
        Returns the name of the extension which this type system item belongs to.

        Any type or decriptor declared by an extension's items.xml owns the name of this extension. Types or descriptors created after initialization do not have an extension name automatically.

      • setExtensionName

        public void setExtensionName​(java.lang.String extname)
        Changes the name of the extension which this type system item belongs to.

        Any type or decriptor declared by an extension's items.xml owns the name of this extension. Types or descriptors created after initialization do not have an extension name automatically.

      • isDeprecated

        public boolean isDeprecated()
        Tells whether this type system element was marked as deprecated by the last re-initialization. This means that this element was created by previous re-initializations and exists as long as the system is initialized completely.

      • isAutocreate

        public boolean isAutocreate()
        Returns:
        true if the type system element should be create automatically during initialization.

      • setAutocreate

        public void setAutocreate​(boolean auto)
        Defines if this type type system element should be create automatically during initialization.

      • isGenerate

        public boolean isGenerate()
        Returns:
        true if jalo code should be generated for this type system element by build process.

      • setGenerate

        public void setGenerate​(boolean gen)
        Defines if jalo code should be generated for this type system element by build process.

      • getName

        public java.lang.String getName()
        Returns:
        the name of this type system item localized for the current session language

      • getName

        public java.lang.String getName​(SessionContext ctx)
        Parameters:
        ctx - the session context specifying the language to get the name for
        Returns:
        the name of this type system item localized for the specified session context

      • getAllNames

        public java.util.Map getAllNames​(SessionContext ctx)
        Gives all names in form of a language-to-name map.

      • setAllNames

        public void setAllNames​(SessionContext ctx,
                        java.util.Map names)
        Sets all names at once. All previous names are removed.
        Parameters:
        names - a map containing language-to-name mappings

      • getAllNames

        public java.util.Map getAllNames()
        Gives all names in form of a language-to-name map.

      • setName

        public void setName​(java.lang.String name)
        Changes the name of this type system item for the current session language.
        Parameters:
        name - the new name

      • setName

        public void setName​(SessionContext ctx,
                    java.lang.String name)
        Changes the name of this type system item for the specified language.
        Parameters:
        ctx - the session context defining the language to change the name for
        name - the new name

      • setAllNames

        public void setAllNames​(java.util.Map names)
        Sets all names at once. All previous names are removed.
        Parameters:
        names - a map containing language-to-name mappings

      • exportXMLDefinition

        public abstract java.lang.String exportXMLDefinition​(org.znerd.xmlenc.XMLOutputter xout)