Package de.hybris.platform.commons.jalo

Class GeneratedDocument

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

    • Constructor Detail

      • GeneratedDocument

        public GeneratedDocument()

    • Method Detail

      • 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 Media
        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

      • getFormat

        public Format getFormat​(SessionContext ctx)
        Generated method - Getter of the Document.format attribute.
        Returns:
        the format - The format of the document

      • getFormat

        public Format getFormat()
        Generated method - Getter of the Document.format attribute.
        Returns:
        the format - The format of the document

      • setFormat

        protected void setFormat​(SessionContext ctx,
                         Format value)
        Generated method - Setter of the Document.format attribute.
        Parameters:
        value - the format - The format of the document

      • setFormat

        protected void setFormat​(Format value)
        Generated method - Setter of the Document.format attribute.
        Parameters:
        value - the format - The format of the document

      • getItemTimestamp

        public java.util.Date getItemTimestamp​(SessionContext ctx)
        Generated method - Getter of the Document.itemTimestamp attribute.
        Returns:
        the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • getItemTimestamp

        public java.util.Date getItemTimestamp()
        Generated method - Getter of the Document.itemTimestamp attribute.
        Returns:
        the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • setItemTimestamp

        public void setItemTimestamp​(SessionContext ctx,
                             java.util.Date value)
        Generated method - Setter of the Document.itemTimestamp attribute.
        Parameters:
        value - the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • setItemTimestamp

        public void setItemTimestamp​(java.util.Date value)
        Generated method - Setter of the Document.itemTimestamp attribute.
        Parameters:
        value - the itemTimestamp - The modified time of the attached item. If the time of the item is younger than the value of this document it could be outdated.

      • getSourceItem

        public Item getSourceItem​(SessionContext ctx)
        Generated method - Getter of the Document.sourceItem attribute.
        Returns:
        the sourceItem

      • getSourceItem

        public Item getSourceItem()
        Generated method - Getter of the Document.sourceItem attribute.
        Returns:
        the sourceItem

      • setSourceItem

        protected void setSourceItem​(SessionContext ctx,
                             Item value)
        Generated method - Setter of the Document.sourceItem attribute.
        Parameters:
        value - the sourceItem

      • setSourceItem

        protected void setSourceItem​(Item value)
        Generated method - Setter of the Document.sourceItem attribute.
        Parameters:
        value - the sourceItem