Package com.priint.pubserver.plugin.entitydata

Class Bucket

    • Method Detail

      • getGroupIdentifier

        public java.lang.String getGroupIdentifier()
        String key for grouping buckets of the same type.
        Returns:
        group identifier string or null if not set

      • setGroupIdentifier

        public void setGroupIdentifier​(java.lang.String groupIdentifier)
        Parameters:
        groupIdentifier - see getGroupIdentifier()

      • getVersion

        public java.lang.String getVersion()
        Version string from the content system
        Returns:
        version string or null if not set

      • setVersion

        public void setVersion​(java.lang.String version)
        Parameters:
        version - see getVersion()

      • getTimestamp

        public java.lang.String getTimestamp()
        Get timestamp from the content system.

        Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.

        Returns:
        timestamp string

      • setTimestamp

        public void setTimestamp​(java.lang.String timestamp)
        Parameters:
        timestamp - see getTimestamp()

      • getLabel

        public java.lang.String getLabel()
        Display label for the bucket.
        Returns:
        label or null if not set

      • setLabel

        public void setLabel​(java.lang.String label)
        Parameters:
        label - see getLabel()

      • getTemplate

        public java.lang.String getTemplate()
        Get String identifier of the priint:comet template.
        Returns:
        template id or null if not set

      • setTemplate

        public void setTemplate​(java.lang.String template)
        Parameters:
        template - see getTemplate()

      • getEntity

        public EntityBucket getEntity()
        Returns:
        the bucket entity object associated with the current bucket or null if not set
        Since:
        4.0.0
        See Also:
        getEntityBucketId()

      • setEntity

        public void setEntity​(EntityBucket entityBucket)
        Sets entityBucket and entityBucketId.
        Parameters:
        entityBucket - bucket entity of the entity model
        Since:
        4.0.0
        See Also:
        setEntityBucketId(String)

      • setParentBucket

        public void setParentBucket​(Bucket parentBucket)
        Sets parentBucket and related parentBucketId if bucket is not null.
        Parameters:
        parentBucket - parentBucket or null
        Since:
        4.0.0
        See Also:
        setParentBucketId(String)

      • setContext

        public void setContext​(Context context)
        Description copied from interface: EntityData
        set the context of entity data object
        Specified by:
        setContext in interface EntityData
        Parameters:
        context - the context for the bucket

      • getSequence

        public int getSequence()
        Get sequence number for the bucket as given in the content system.

        This should reflect the position of the current bucket in the sorting of subBuckets of its parentBucket.

        Specified by:
        getSequence in interface GetSequence
        Returns:
        ordered position within a list sequenceable objects

      • setSequence

        public void setSequence​(int sequence)
        Parameters:
        sequence - see getSequence()

      • getCords

        public java.util.List<Cord> getCords()
        Returns:
        list of cords related to the bucket or an empty list.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setCords

        public void setCords​(java.util.List<Cord> cords)
        Parameters:
        cords - list of cords related to the bucket or null

      • getTexts

        public java.util.List<Text> getTexts()
        Returns:
        List of texts related to the bucket or a null.
        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setTexts

        public void setTexts​(java.util.List<Text> texts)
        Parameters:
        texts - List of texts related to the bucket

      • getSubBuckets

        public java.util.List<Bucket> getSubBuckets()
        Returns:
        List of child buckets of the bucket or null.
        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setSubBuckets

        public void setSubBuckets​(java.util.List<Bucket> subBuckets)
        Parameters:
        subBuckets - see getSubBuckets()

      • getMediaAssets

        public java.util.List<MediaAsset> getMediaAssets()
        Returns:
        List of media assets related to the bucket or null.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setMediaAssets

        public void setMediaAssets​(java.util.List<MediaAsset> mediaAssets)
        Parameters:
        mediaAssets - see getMediaAssets()

      • getPrices

        public java.util.List<Price> getPrices()
        Returns:
        List of prices related to the bucket or null.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setPrices

        public void setPrices​(java.util.List<Price> prices)
        Parameters:
        prices - see getPrices()

      • getKeyValues

        public java.util.List<KeyValue> getKeyValues()
        Returns:
        List of keyValues related to the bucket or null.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setKeyValues

        public void setKeyValues​(java.util.List<KeyValue> keyValues)
        Parameters:
        keyValues - see getKeyValues()

      • getMetaData

        public java.util.List<KeyValue> getMetaData()
        Returns:
        List of meta data related to the bucket or empty list.

        List is LAZY loaded.

      • setMetaData

        public void setMetaData​(java.util.List<KeyValue> metaData)
        Parameters:
        metaData - see getMetaData()

      • getConnectorEntity

        public ConnectorEntity getConnectorEntity()
        Returns:
        connector entity object or null if not set

      • getCreatedBy

        public java.lang.String getCreatedBy()
        Returns:
        creation user or null if not set

      • setCreatedBy

        public void setCreatedBy​(java.lang.String createdBy)
        Parameters:
        createdBy - see getCreatedBy()

      • getCreatedOn

        public java.util.Date getCreatedOn()
        Returns:
        creation date or null if not set

      • setCreatedOn

        public void setCreatedOn​(java.util.Date createdOn)
        Parameters:
        createdOn - see getCreatedOn()

      • getUpdatedBy

        public java.lang.String getUpdatedBy()
        Returns:
        last modified user or null if not set

      • setUpdatedBy

        public void setUpdatedBy​(java.lang.String updatedBy)
        Parameters:
        updatedBy - see getUpdatedBy()

      • getUpdatedOn

        public java.util.Date getUpdatedOn()
        Returns:
        last modified date or null if not set

      • setUpdatedOn

        public void setUpdatedOn​(java.util.Date updatedOn)
        Parameters:
        updatedOn - see getUpdatedOn()

      • getEntityBucketId

        public java.lang.String getEntityBucketId()
        Returns:
        identifier of the bucket entity or null if not set

      • setEntityBucketId

        public void setEntityBucketId​(java.lang.String entityBucketId)
        Sets entityBucketId and eventually removes current entityBucket if it does not match the id
        Parameters:
        entityBucketId - see getEntityBucketId()
        Since:
        4.0.0

      • setParentBucketId

        public void setParentBucketId​(java.lang.String parentBucketId)
        Set parentBucketId and eventually removes current parentBucket if it does not match the id.
        Parameters:
        parentBucketId - identifier of the parent bucket
        Since:
        4.0.0

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getTableData

        public java.util.List<TableData> getTableData()
        Returns:
        List of TableData.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

      • setTableData

        public void setTableData​(java.util.List<TableData> tableData)

      • getOrigin

        public java.lang.String getOrigin()
        Returns:
        Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return null.

      • setOrigin

        public void setOrigin​(java.lang.String origin)
        Parameters:
        origin - getOrigin()

      • getEntityIdentifier

        public java.lang.String getEntityIdentifier()
        Description copied from interface: EntityData
        Identifier of an entity in the entity model where the current object refers to.
        Specified by:
        getEntityIdentifier in interface EntityData
        Returns:
        entity identifier as string

      • setEntityIdentifier

        public void setEntityIdentifier​(java.lang.String entityIdentifier)
        Description copied from interface: EntityData
        Identifier of an entity in the entity model where the current object refers to.
        Specified by:
        setEntityIdentifier in interface EntityData

      • getPageTemplateId

        public java.lang.String getPageTemplateId()

      • setPageTemplateId

        public void setPageTemplateId​(java.lang.String pageTemplateId)

      • getContentMetaData

        public java.util.List<ContentMetaData> getContentMetaData()
        Returns:
        List of ContentMetaData related to Bucket.

        List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.