Class GeneratedComponent

All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
Component

public abstract class GeneratedComponent extends GenericItem
Generated class for type Component.
See Also:
  • Field Details

    • CODE

      public static final String CODE
      Qualifier of the Component.code attribute
      See Also:
    • NAME

      public static final String NAME
      Qualifier of the Component.name attribute
      See Also:
    • AVAILABLECOMMENTTYPES

      public static final String AVAILABLECOMMENTTYPES
      Qualifier of the Component.availableCommentTypes attribute
      See Also:
    • DOMAIN

      public static final String DOMAIN
      Qualifier of the Component.domain attribute
      See Also:
    • COMMENT

      public static final String COMMENT
      Qualifier of the Component.comment attribute
      See Also:
    • READPERMITTED

      public static final String READPERMITTED
      Qualifier of the Component.readPermitted attribute
      See Also:
    • COMPONENTREADPRINCIPALRELATION_SRC_ORDERED

      protected static String COMPONENTREADPRINCIPALRELATION_SRC_ORDERED
      Relation ordering override parameter constants for ComponentReadPrincipalRelation from ((comments))
    • COMPONENTREADPRINCIPALRELATION_TGT_ORDERED

      protected static String COMPONENTREADPRINCIPALRELATION_TGT_ORDERED
    • COMPONENTREADPRINCIPALRELATION_MARKMODIFIED

      protected static String COMPONENTREADPRINCIPALRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for ComponentReadPrincipalRelation from ((comments))
    • WRITEPERMITTED

      public static final String WRITEPERMITTED
      Qualifier of the Component.writePermitted attribute
      See Also:
    • COMPONENTWRITEPRINCIPALRELATION_SRC_ORDERED

      protected static String COMPONENTWRITEPRINCIPALRELATION_SRC_ORDERED
      Relation ordering override parameter constants for ComponentWritePrincipalRelation from ((comments))
    • COMPONENTWRITEPRINCIPALRELATION_TGT_ORDERED

      protected static String COMPONENTWRITEPRINCIPALRELATION_TGT_ORDERED
    • COMPONENTWRITEPRINCIPALRELATION_MARKMODIFIED

      protected static String COMPONENTWRITEPRINCIPALRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for ComponentWritePrincipalRelation from ((comments))
    • CREATEPERMITTED

      public static final String CREATEPERMITTED
      Qualifier of the Component.createPermitted attribute
      See Also:
    • COMPONENTCREATEPRINCIPALRELATION_SRC_ORDERED

      protected static String COMPONENTCREATEPRINCIPALRELATION_SRC_ORDERED
      Relation ordering override parameter constants for ComponentCreatePrincipalRelation from ((comments))
    • COMPONENTCREATEPRINCIPALRELATION_TGT_ORDERED

      protected static String COMPONENTCREATEPRINCIPALRELATION_TGT_ORDERED
    • COMPONENTCREATEPRINCIPALRELATION_MARKMODIFIED

      protected static String COMPONENTCREATEPRINCIPALRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for ComponentCreatePrincipalRelation from ((comments))
    • REMOVEPERMITTED

      public static final String REMOVEPERMITTED
      Qualifier of the Component.removePermitted attribute
      See Also:
    • COMPONENTREMOVEPRINCIPALRELATION_SRC_ORDERED

      protected static String COMPONENTREMOVEPRINCIPALRELATION_SRC_ORDERED
      Relation ordering override parameter constants for ComponentRemovePrincipalRelation from ((comments))
    • COMPONENTREMOVEPRINCIPALRELATION_TGT_ORDERED

      protected static String COMPONENTREMOVEPRINCIPALRELATION_TGT_ORDERED
    • COMPONENTREMOVEPRINCIPALRELATION_MARKMODIFIED

      protected static String COMPONENTREMOVEPRINCIPALRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for ComponentRemovePrincipalRelation from ((comments))
    • DOMAINHANDLER

      protected static final BidirectionalOneToManyHandler<GeneratedComponent> DOMAINHANDLER
      BidirectionalOneToManyHandler for handling 1:n DOMAIN's relation attributes from 'one' side.
    • COMMENTHANDLER

      protected static final OneToManyHandler<Comment> COMMENTHANDLER
      OneToManyHandler for handling 1:n COMMENT's relation attributes from 'many' side.
    • DEFAULT_INITIAL_ATTRIBUTES

      protected static final Map<String,Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES
  • Constructor Details

    • GeneratedComponent

      public GeneratedComponent()
  • Method Details

    • getDefaultAttributeModes

      protected Map<String,Item.AttributeMode> getDefaultAttributeModes()
      Overrides:
      getDefaultAttributeModes in class Item
    • getAvailableCommentTypes

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

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

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

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

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

      protected void setCode(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 Collection<Principal> getCreatePermitted(SessionContext ctx)
      Generated method - Getter of the Component.createPermitted attribute.
      Returns:
      the createPermitted
    • getCreatePermitted

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

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

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

      public long getCreatePermittedCount(SessionContext ctx, Language lang)
    • getCreatePermittedCount

      public long getCreatePermittedCount(Language lang)
    • getCreatePermittedCount

      public long getCreatePermittedCount(SessionContext ctx)
    • getCreatePermittedCount

      public long getCreatePermittedCount()
    • setCreatePermitted

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

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

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

      public void setAllCreatePermitted(Map<Language,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
    • isMarkModifiedDisabled

      @Deprecated(since="2105", forRemoval=true) public boolean isMarkModifiedDisabled(Item referencedItem)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isMarkModifiedDisabled in class Item
    • getName

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

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

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

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

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

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

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

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

      public long getReadPermittedCount(SessionContext ctx, Language lang)
    • getReadPermittedCount

      public long getReadPermittedCount(Language lang)
    • getReadPermittedCount

      public long getReadPermittedCount(SessionContext ctx)
    • getReadPermittedCount

      public long getReadPermittedCount()
    • setReadPermitted

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

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

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

      public void setAllReadPermitted(Map<Language,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 Collection<Principal> getRemovePermitted(SessionContext ctx)
      Generated method - Getter of the Component.removePermitted attribute.
      Returns:
      the removePermitted
    • getRemovePermitted

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

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

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

      public long getRemovePermittedCount(SessionContext ctx, Language lang)
    • getRemovePermittedCount

      public long getRemovePermittedCount(Language lang)
    • getRemovePermittedCount

      public long getRemovePermittedCount(SessionContext ctx)
    • getRemovePermittedCount

      public long getRemovePermittedCount()
    • setRemovePermitted

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

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

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

      public void setAllRemovePermitted(Map<Language,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 Collection<Principal> getWritePermitted(SessionContext ctx)
      Generated method - Getter of the Component.writePermitted attribute.
      Returns:
      the writePermitted
    • getWritePermitted

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

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

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

      public long getWritePermittedCount(SessionContext ctx, Language lang)
    • getWritePermittedCount

      public long getWritePermittedCount(Language lang)
    • getWritePermittedCount

      public long getWritePermittedCount(SessionContext ctx)
    • getWritePermittedCount

      public long getWritePermittedCount()
    • setWritePermitted

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

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

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

      public void setAllWritePermitted(Map<Language,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