Package de.hybris.platform.comments.jalo

Class GeneratedComponent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable
    Direct Known Subclasses:
    Component
    public abstract class GeneratedComponent
extends GenericItem
    Generated class for type Component.
    See Also:
    Serialized Form

    • Field Detail

      • CODE

        public static final java.lang.String CODE
        Qualifier of the Component.code attribute
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Qualifier of the Component.name attribute
        See Also:
        Constant Field Values

      • AVAILABLECOMMENTTYPES

        public static final java.lang.String AVAILABLECOMMENTTYPES
        Qualifier of the Component.availableCommentTypes attribute
        See Also:
        Constant Field Values

      • DOMAIN

        public static final java.lang.String DOMAIN
        Qualifier of the Component.domain attribute
        See Also:
        Constant Field Values

      • COMMENT

        public static final java.lang.String COMMENT
        Qualifier of the Component.comment attribute
        See Also:
        Constant Field Values

      • READPERMITTED

        public static final java.lang.String READPERMITTED
        Qualifier of the Component.readPermitted attribute
        See Also:
        Constant Field Values

      • COMPONENTREADPRINCIPALRELATION_SRC_ORDERED

        protected static java.lang.String COMPONENTREADPRINCIPALRELATION_SRC_ORDERED
        Relation ordering override parameter constants for ComponentReadPrincipalRelation from ((comments))

      • COMPONENTREADPRINCIPALRELATION_TGT_ORDERED

        protected static java.lang.String COMPONENTREADPRINCIPALRELATION_TGT_ORDERED

      • COMPONENTREADPRINCIPALRELATION_MARKMODIFIED

        protected static java.lang.String COMPONENTREADPRINCIPALRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for ComponentReadPrincipalRelation from ((comments))

      • WRITEPERMITTED

        public static final java.lang.String WRITEPERMITTED
        Qualifier of the Component.writePermitted attribute
        See Also:
        Constant Field Values

      • COMPONENTWRITEPRINCIPALRELATION_SRC_ORDERED

        protected static java.lang.String COMPONENTWRITEPRINCIPALRELATION_SRC_ORDERED
        Relation ordering override parameter constants for ComponentWritePrincipalRelation from ((comments))

      • COMPONENTWRITEPRINCIPALRELATION_TGT_ORDERED

        protected static java.lang.String COMPONENTWRITEPRINCIPALRELATION_TGT_ORDERED

      • COMPONENTWRITEPRINCIPALRELATION_MARKMODIFIED

        protected static java.lang.String COMPONENTWRITEPRINCIPALRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for ComponentWritePrincipalRelation from ((comments))

      • CREATEPERMITTED

        public static final java.lang.String CREATEPERMITTED
        Qualifier of the Component.createPermitted attribute
        See Also:
        Constant Field Values

      • COMPONENTCREATEPRINCIPALRELATION_SRC_ORDERED

        protected static java.lang.String COMPONENTCREATEPRINCIPALRELATION_SRC_ORDERED
        Relation ordering override parameter constants for ComponentCreatePrincipalRelation from ((comments))

      • COMPONENTCREATEPRINCIPALRELATION_TGT_ORDERED

        protected static java.lang.String COMPONENTCREATEPRINCIPALRELATION_TGT_ORDERED

      • COMPONENTCREATEPRINCIPALRELATION_MARKMODIFIED

        protected static java.lang.String COMPONENTCREATEPRINCIPALRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for ComponentCreatePrincipalRelation from ((comments))

      • REMOVEPERMITTED

        public static final java.lang.String REMOVEPERMITTED
        Qualifier of the Component.removePermitted attribute
        See Also:
        Constant Field Values

      • COMPONENTREMOVEPRINCIPALRELATION_SRC_ORDERED

        protected static java.lang.String COMPONENTREMOVEPRINCIPALRELATION_SRC_ORDERED
        Relation ordering override parameter constants for ComponentRemovePrincipalRelation from ((comments))

      • COMPONENTREMOVEPRINCIPALRELATION_TGT_ORDERED

        protected static java.lang.String COMPONENTREMOVEPRINCIPALRELATION_TGT_ORDERED

      • COMPONENTREMOVEPRINCIPALRELATION_MARKMODIFIED

        protected static java.lang.String COMPONENTREMOVEPRINCIPALRELATION_MARKMODIFIED
        Relation disable markmodifed parameter constants for ComponentRemovePrincipalRelation from ((comments))

      • DEFAULT_INITIAL_ATTRIBUTES

        protected static final java.util.Map<java.lang.String,​Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES

    • Constructor Detail

      • GeneratedComponent

        public GeneratedComponent()

    • Method Detail

      • getAvailableCommentTypes

        public abstract java.util.Collection<CommentType> getAvailableCommentTypes​(SessionContext ctx)
        Generated method - Getter of the Component.availableCommentTypes attribute.
        Returns:
        the availableCommentTypes

      • getAvailableCommentTypes

        public java.util.Collection<CommentType> getAvailableCommentTypes()
        Generated method - Getter of the Component.availableCommentTypes attribute.
        Returns:
        the availableCommentTypes

      • getCode

        public java.lang.String getCode​(SessionContext ctx)
        Generated method - Getter of the Component.code attribute.
        Returns:
        the code - unique identifier of the component

      • getCode

        public java.lang.String getCode()
        Generated method - Getter of the Component.code attribute.
        Returns:
        the code - unique identifier of the component

      • setCode

        protected void setCode​(SessionContext ctx,
                       java.lang.String value)
        Generated method - Setter of the Component.code attribute.
        Parameters:
        value - the code - unique identifier of the component

      • setCode

        protected void setCode​(java.lang.String value)
        Generated method - Setter of the Component.code attribute.
        Parameters:
        value - the code - unique identifier of the component

      • createItem

        protected Item createItem​(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException
        Description copied from class: Item
        Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

        In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
        Sn example: 

        
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
        Overrides:
        createItem in class GenericItem
        Parameters:
        ctx - the current session context which this item is created within
        type - 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

      • getCreatePermitted

        public java.util.Collection<Principal> getCreatePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.createPermitted attribute.
        Returns:
        the createPermitted

      • getCreatePermitted

        public java.util.Collection<Principal> getCreatePermitted()
        Generated method - Getter of the Component.createPermitted attribute.
        Returns:
        the createPermitted

      • getAllCreatePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllCreatePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.createPermitted attribute.
        Returns:
        the localized createPermitted

      • getAllCreatePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllCreatePermitted()
        Generated method - Getter of the Component.createPermitted attribute.
        Returns:
        the localized createPermitted

      • getCreatePermittedCount

        public long getCreatePermittedCount​(Language lang)

      • getCreatePermittedCount

        public long getCreatePermittedCount​(SessionContext ctx)

      • getCreatePermittedCount

        public long getCreatePermittedCount()

      • setCreatePermitted

        public void setCreatePermitted​(SessionContext ctx,
                               java.util.Collection<Principal> value)
        Generated method - Setter of the Component.createPermitted attribute.
        Parameters:
        value - the createPermitted

      • setCreatePermitted

        public void setCreatePermitted​(java.util.Collection<Principal> value)
        Generated method - Setter of the Component.createPermitted attribute.
        Parameters:
        value - the createPermitted

      • setAllCreatePermitted

        public void setAllCreatePermitted​(SessionContext ctx,
                                  java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.createPermitted attribute.
        Parameters:
        value - the createPermitted

      • setAllCreatePermitted

        public void setAllCreatePermitted​(java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.createPermitted attribute.
        Parameters:
        value - the createPermitted

      • addToCreatePermitted

        public void addToCreatePermitted​(SessionContext ctx,
                                 Language lang,
                                 Principal value)
        Generated method - Adds value to createPermitted.
        Parameters:
        value - the item to add to createPermitted

      • addToCreatePermitted

        public void addToCreatePermitted​(Language lang,
                                 Principal value)
        Generated method - Adds value to createPermitted.
        Parameters:
        value - the item to add to createPermitted

      • removeFromCreatePermitted

        public void removeFromCreatePermitted​(SessionContext ctx,
                                      Language lang,
                                      Principal value)
        Generated method - Removes value from createPermitted.
        Parameters:
        value - the item to remove from createPermitted

      • removeFromCreatePermitted

        public void removeFromCreatePermitted​(Language lang,
                                      Principal value)
        Generated method - Removes value from createPermitted.
        Parameters:
        value - the item to remove from createPermitted

      • getDomain

        public Domain getDomain​(SessionContext ctx)
        Generated method - Getter of the Component.domain attribute.
        Returns:
        the domain

      • getDomain

        public Domain getDomain()
        Generated method - Getter of the Component.domain attribute.
        Returns:
        the domain

      • setDomain

        protected void setDomain​(SessionContext ctx,
                         Domain value)
        Generated method - Setter of the Component.domain attribute.
        Parameters:
        value - the domain

      • setDomain

        protected void setDomain​(Domain value)
        Generated method - Setter of the Component.domain attribute.
        Parameters:
        value - the domain

      • getName

        public java.lang.String getName​(SessionContext ctx)
        Generated method - Getter of the Component.name attribute.
        Returns:
        the name - Name of the component

      • getName

        public java.lang.String getName()
        Generated method - Getter of the Component.name attribute.
        Returns:
        the name - Name of the component

      • setName

        public void setName​(SessionContext ctx,
                    java.lang.String value)
        Generated method - Setter of the Component.name attribute.
        Parameters:
        value - the name - Name of the component

      • setName

        public void setName​(java.lang.String value)
        Generated method - Setter of the Component.name attribute.
        Parameters:
        value - the name - Name of the component

      • getReadPermitted

        public java.util.Collection<Principal> getReadPermitted​(SessionContext ctx)
        Generated method - Getter of the Component.readPermitted attribute.
        Returns:
        the readPermitted

      • getReadPermitted

        public java.util.Collection<Principal> getReadPermitted()
        Generated method - Getter of the Component.readPermitted attribute.
        Returns:
        the readPermitted

      • getAllReadPermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllReadPermitted​(SessionContext ctx)
        Generated method - Getter of the Component.readPermitted attribute.
        Returns:
        the localized readPermitted

      • getAllReadPermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllReadPermitted()
        Generated method - Getter of the Component.readPermitted attribute.
        Returns:
        the localized readPermitted

      • getReadPermittedCount

        public long getReadPermittedCount​(Language lang)

      • getReadPermittedCount

        public long getReadPermittedCount​(SessionContext ctx)

      • getReadPermittedCount

        public long getReadPermittedCount()

      • setReadPermitted

        public void setReadPermitted​(SessionContext ctx,
                             java.util.Collection<Principal> value)
        Generated method - Setter of the Component.readPermitted attribute.
        Parameters:
        value - the readPermitted

      • setReadPermitted

        public void setReadPermitted​(java.util.Collection<Principal> value)
        Generated method - Setter of the Component.readPermitted attribute.
        Parameters:
        value - the readPermitted

      • setAllReadPermitted

        public void setAllReadPermitted​(SessionContext ctx,
                                java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.readPermitted attribute.
        Parameters:
        value - the readPermitted

      • setAllReadPermitted

        public void setAllReadPermitted​(java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.readPermitted attribute.
        Parameters:
        value - the readPermitted

      • addToReadPermitted

        public void addToReadPermitted​(SessionContext ctx,
                               Language lang,
                               Principal value)
        Generated method - Adds value to readPermitted.
        Parameters:
        value - the item to add to readPermitted

      • addToReadPermitted

        public void addToReadPermitted​(Language lang,
                               Principal value)
        Generated method - Adds value to readPermitted.
        Parameters:
        value - the item to add to readPermitted

      • removeFromReadPermitted

        public void removeFromReadPermitted​(SessionContext ctx,
                                    Language lang,
                                    Principal value)
        Generated method - Removes value from readPermitted.
        Parameters:
        value - the item to remove from readPermitted

      • removeFromReadPermitted

        public void removeFromReadPermitted​(Language lang,
                                    Principal value)
        Generated method - Removes value from readPermitted.
        Parameters:
        value - the item to remove from readPermitted

      • getRemovePermitted

        public java.util.Collection<Principal> getRemovePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.removePermitted attribute.
        Returns:
        the removePermitted

      • getRemovePermitted

        public java.util.Collection<Principal> getRemovePermitted()
        Generated method - Getter of the Component.removePermitted attribute.
        Returns:
        the removePermitted

      • getAllRemovePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllRemovePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.removePermitted attribute.
        Returns:
        the localized removePermitted

      • getAllRemovePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllRemovePermitted()
        Generated method - Getter of the Component.removePermitted attribute.
        Returns:
        the localized removePermitted

      • getRemovePermittedCount

        public long getRemovePermittedCount​(Language lang)

      • getRemovePermittedCount

        public long getRemovePermittedCount​(SessionContext ctx)

      • getRemovePermittedCount

        public long getRemovePermittedCount()

      • setRemovePermitted

        public void setRemovePermitted​(SessionContext ctx,
                               java.util.Collection<Principal> value)
        Generated method - Setter of the Component.removePermitted attribute.
        Parameters:
        value - the removePermitted

      • setRemovePermitted

        public void setRemovePermitted​(java.util.Collection<Principal> value)
        Generated method - Setter of the Component.removePermitted attribute.
        Parameters:
        value - the removePermitted

      • setAllRemovePermitted

        public void setAllRemovePermitted​(SessionContext ctx,
                                  java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.removePermitted attribute.
        Parameters:
        value - the removePermitted

      • setAllRemovePermitted

        public void setAllRemovePermitted​(java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.removePermitted attribute.
        Parameters:
        value - the removePermitted

      • addToRemovePermitted

        public void addToRemovePermitted​(SessionContext ctx,
                                 Language lang,
                                 Principal value)
        Generated method - Adds value to removePermitted.
        Parameters:
        value - the item to add to removePermitted

      • addToRemovePermitted

        public void addToRemovePermitted​(Language lang,
                                 Principal value)
        Generated method - Adds value to removePermitted.
        Parameters:
        value - the item to add to removePermitted

      • removeFromRemovePermitted

        public void removeFromRemovePermitted​(SessionContext ctx,
                                      Language lang,
                                      Principal value)
        Generated method - Removes value from removePermitted.
        Parameters:
        value - the item to remove from removePermitted

      • removeFromRemovePermitted

        public void removeFromRemovePermitted​(Language lang,
                                      Principal value)
        Generated method - Removes value from removePermitted.
        Parameters:
        value - the item to remove from removePermitted

      • getWritePermitted

        public java.util.Collection<Principal> getWritePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.writePermitted attribute.
        Returns:
        the writePermitted

      • getWritePermitted

        public java.util.Collection<Principal> getWritePermitted()
        Generated method - Getter of the Component.writePermitted attribute.
        Returns:
        the writePermitted

      • getAllWritePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllWritePermitted​(SessionContext ctx)
        Generated method - Getter of the Component.writePermitted attribute.
        Returns:
        the localized writePermitted

      • getAllWritePermitted

        public java.util.Map<Language,​java.util.Collection<Principal>> getAllWritePermitted()
        Generated method - Getter of the Component.writePermitted attribute.
        Returns:
        the localized writePermitted

      • getWritePermittedCount

        public long getWritePermittedCount​(Language lang)

      • getWritePermittedCount

        public long getWritePermittedCount​(SessionContext ctx)

      • getWritePermittedCount

        public long getWritePermittedCount()

      • setWritePermitted

        public void setWritePermitted​(SessionContext ctx,
                              java.util.Collection<Principal> value)
        Generated method - Setter of the Component.writePermitted attribute.
        Parameters:
        value - the writePermitted

      • setWritePermitted

        public void setWritePermitted​(java.util.Collection<Principal> value)
        Generated method - Setter of the Component.writePermitted attribute.
        Parameters:
        value - the writePermitted

      • setAllWritePermitted

        public void setAllWritePermitted​(SessionContext ctx,
                                 java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.writePermitted attribute.
        Parameters:
        value - the writePermitted

      • setAllWritePermitted

        public void setAllWritePermitted​(java.util.Map<Language,​java.util.Collection<Principal>> value)
        Generated method - Setter of the Component.writePermitted attribute.
        Parameters:
        value - the writePermitted

      • addToWritePermitted

        public void addToWritePermitted​(SessionContext ctx,
                                Language lang,
                                Principal value)
        Generated method - Adds value to writePermitted.
        Parameters:
        value - the item to add to writePermitted

      • addToWritePermitted

        public void addToWritePermitted​(Language lang,
                                Principal value)
        Generated method - Adds value to writePermitted.
        Parameters:
        value - the item to add to writePermitted

      • removeFromWritePermitted

        public void removeFromWritePermitted​(SessionContext ctx,
                                     Language lang,
                                     Principal value)
        Generated method - Removes value from writePermitted.
        Parameters:
        value - the item to remove from writePermitted

      • removeFromWritePermitted

        public void removeFromWritePermitted​(Language lang,
                                     Principal value)
        Generated method - Removes value from writePermitted.
        Parameters:
        value - the item to remove from writePermitted