Package com.day.cq.dam.api.handler.xmp

Interface XMPWriteBackOptions

  • public interface XMPWriteBackOptions
    The XMPWriteBackOptions interface defines the options for writing XMP metadata information to a binary.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void createVersion​(boolean createVersion)
      Sets the value whether version is to be created for an asset on each writeback
      java.util.Set<Rendition> getRenditions()
      Returns the set of renditions of an Asset for which XMP meta writeback has to be done
      java.lang.String getVersionCreator()
      XMP Writeback updates DamConstants.PN_VERSION_CREATOR of the asset as returned by this API.
      boolean isCreateVersion()
      Returns whether a version needs to be created or not for an asset on each writeback
      void setRenditions​(java.util.Set<Rendition> renditions)
      Sets the renditions for which XMP meta writeback has to be done
      void setVersionCreator​(java.lang.String userId)
      Allows XMP Writeback to update DamConstants.PN_VERSION_CREATOR of the asset Applicable only when isCreateVersion() returns true

    • Method Detail

      • isCreateVersion

        boolean isCreateVersion()
        Returns whether a version needs to be created or not for an asset on each writeback
        Returns:
        createVersion

      • createVersion

        void createVersion​(boolean createVersion)
        Sets the value whether version is to be created for an asset on each writeback
        Parameters:
        createVersion - if true then create versions of the asset on each writeback

      • getRenditions

        java.util.Set<Rendition> getRenditions()
        Returns the set of renditions of an Asset for which XMP meta writeback has to be done
        Returns:
        renditions

      • setRenditions

        void setRenditions​(java.util.Set<Rendition> renditions)
        Sets the renditions for which XMP meta writeback has to be done
        Parameters:
        renditions - asset's renditions for which XMP meta writeback has to be done

      • setVersionCreator

        void setVersionCreator​(java.lang.String userId)
        Allows XMP Writeback to update DamConstants.PN_VERSION_CREATOR of the asset Applicable only when isCreateVersion() returns true
        Parameters:
        userId - principal of the user that should be updated as creator of the version

      • getVersionCreator

        java.lang.String getVersionCreator()
        XMP Writeback updates DamConstants.PN_VERSION_CREATOR of the asset as returned by this API. Applicable only when isCreateVersion() returns true
        Returns:
        userId principal of the user that should be updated as creator of the version or empty string if none was set using setVersionCreator(java.lang.String)