Package com.atlassian.confluence.core

Interface ContentPropertyManager

  • All Known Implementing Classes:
    ReadThroughCachingContentPropertyManager
    @Transactional
public interface ContentPropertyManager
    This interface should be considered almost-deprecated - unless you're retrieving or modifying existing content properties that were added using a ContentPropertyManager, you should use the entity's ContentProperties instead.

    • Method Detail

      • getStringProperty

        @Transactional(readOnly=true)
@Nullable String getStringProperty​(ContentEntityObject entity,
                                   String key)
        Get a string property associated with a content entity object, or null if that property is not set. String properties can not be longer than 255 characters
        Parameters:
        entity - the entity the property is associated with
        key - the key with which to look up the property
        Returns:
        the property, or null if no such property exists

      • setStringProperty

        @Transactional
void setStringProperty​(ContentEntityObject entity,
                       String key,
                       String value)
        Associate a string property with a content entity object, or null if that property is not set. String properties can not be longer than 255 characters. If a property is set longer than 255 characters, it will be truncated.
        Parameters:
        entity - the entity the property is associated with
        key - the key with which to look up the property
        value - the value to set

      • getTextProperty

        @Transactional(readOnly=true)
@Nullable String getTextProperty​(ContentEntityObject entity,
                                 String key)
        Get a text property associated with a content entity object, or null if that property is not set. Text properties can be longer than 255 characters, but I suspect anything over 4096 characters will break Oracle.
        Parameters:
        entity - the entity the property is associated with
        key - the key with which to look up the property
        Returns:
        the property, or null if no such property exists

      • setTextProperty

        void setTextProperty​(ContentEntityObject entity,
                     String key,
                     String value)
        Associate a text property with a content entity object, or null if that property is not set.
        Parameters:
        entity - the entity the property is associated with
        key - the key with which to look up the property
        value - the value to set

      • removeProperty

        void removeProperty​(ContentEntityObject entity,
                    String key)
        Remove the property associated with the content entity object.
        Parameters:
        entity - the entity the property is associated with
        key - the key with which to look up the property

      • removeProperties

        void removeProperties​(ContentEntityObject entity)
        Remove all the properties associated with the content entity object.
        Parameters:
        entity - the entity the property is associated with

      • transferProperties

        void transferProperties​(ContentEntityObject source,
                        ContentEntityObject destination)
        Copies all properties associated with the source content entity object to the destination content entity object, and then removes all properties from the source content entity object.

        Intended use is for any properties saved against a Draft to be transferred to the persisted content entity object.

        Parameters:
        source - the entity to copy and remove properties from
        destination - the entity to copy properties to