Class Cord

    • Method Detail

      • getEntity

        public EntityCord getEntity()
        Returns:
        the cord entity object associated with the current cord or null if not set
        Since:
        4.0.0
        See Also:
        getEntityCordId()
      • setEntity

        public void setEntity​(EntityCord entityCord)
        Sets entityCord and entityCordId.
        Parameters:
        entityCord - see getEntity()
      • getSourceBucket

        public Bucket getSourceBucket()
        Get the source bucket of a cord.
        Returns:
        Source bucket or null
      • setSourceBucket

        public void setSourceBucket​(Bucket sourceBucket)
        Parameters:
        sourceBucket - see getSourceBucket()
      • getSourceLabel

        public java.lang.String getSourceLabel()
        Returns:
        Display name for the "from Bucket" relationship
      • setSourceLabel

        public void setSourceLabel​(java.lang.String sourceLabel)
        Parameters:
        sourceLabel - see getSourceLabel()
      • getDestinationBucket

        public Bucket getDestinationBucket()
        Get the destination bucket of a cord.
        Returns:
        Destination bucket or null
      • setDestinationBucket

        public void setDestinationBucket​(Bucket destinationBucket)
        Parameters:
        destinationBucket - see getDestinationBucket()
      • getDestinationLabel

        public java.lang.String getDestinationLabel()
        Returns:
        Display name for the "to Bucket" relationship
      • setDestinationLabel

        public void setDestinationLabel​(java.lang.String destinationLabel)
        Parameters:
        destinationLabel - see getDestinationLabel()
      • getContentBucket

        public Bucket getContentBucket()
        Get ContentBucket collecting MediaAssets, Texts, KeyValues, etc. related to the cord.
        Returns:
        bucket or null
      • setContentBucket

        public void setContentBucket​(Bucket contentBucket)
        Parameters:
        contentBucket - see getContentBucket()
      • getEntityCordId

        public java.lang.String getEntityCordId()
        Returns:
        identifier of the cord entity or null if not set
      • setEntityCordId

        public void setEntityCordId​(java.lang.String entityCordId)
        Sets entityCordId and eventually removes current entityCord if it does not match the id
        Parameters:
        entityCordId - see getEntityCordId()
        Since:
        4.0.0
      • 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()
      • getGroupIdentifier

        public java.lang.String getGroupIdentifier()
        String key for grouping cords 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()
      • getLabel

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

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

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

        List is LAZY loaded.

      • setMetaData

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

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

        This should reflect the position of the current cord in the sorting of cords of its sourceBucket.

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

        public void setSequence​(int sequence)
        Parameters:
        sequence - see getSequence()
      • 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()
      • 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()
      • 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()
      • 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()
      • getSourceBucketId

        public final java.lang.String getSourceBucketId()
        Returns:
        Identifier of related source bucket.
      • setSourceBucketId

        public final void setSourceBucketId​(java.lang.String sourceBucketId)
        Sets sourceBucketId and eventually removes current sourceBucket if it does not match the id
        Parameters:
        sourceBucketId - getSourceBucketId()
      • getDestinationBucketId

        public final java.lang.String getDestinationBucketId()
        Returns:
        Identifier of related destination bucket.
      • setDestinationBucketId

        public final void setDestinationBucketId​(java.lang.String destinationBucketId)
        Sets destinationBucketId and eventually removes current destinationBucket if it does not match the id
        Parameters:
        destinationBucketId - getDestinationBucketId()
      • 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
      • getContentMetaData

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

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

      • toString

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