Package com.day.cq.dam.api.s7dam.set

Interface MediaSet

  • All Superinterfaces:
    Adaptable, Resource
    All Known Subinterfaces:
    CarouselSet, ImageSet, SwatchSet
    @Deprecated
public interface MediaSet
extends Resource
    Deprecated.
    Not for public use - this API will be replaced in a future release
    Represents a Secene7 Media set.

    • Method Detail

      • getMembers

        java.util.Iterator<Asset> getMembers()
        Deprecated.
        Returns an iterator over assets in the Media Set
        Returns:
        iterator over assets Asset in collection.

      • isValidMemberType

        boolean isValidMemberType​(Asset asset)
        Deprecated.
        Checks if the given asset is valid member type of Media Set
        Parameters:
        asset - The asset whose type needs to be checked for membership
        Returns:
        True if asset type is valid for set, false otherwise.

      • contains

        boolean contains​(Asset asset)
        Deprecated.
        Returns true if asset is part of Image Set
        Parameters:
        asset - asset instance to be checked
        Returns:
        true if asset is part of the Image Set. false otherwise

      • add

        boolean add​(Asset asset)
        Deprecated.
        Add an asset to the image set and returns true if successful.
        Parameters:
        asset - asset instance to be added
        Returns:
        true if addition of resource to collection was successful or false if collection already contained the resource.

      • add

        boolean add​(Asset asset,
            Asset swatch)
        Deprecated.
        Add an asset to the image set and returns true if successful.
        Parameters:
        asset - Asset instance to be added
        swatch - Asset as a swatch for this asset
        Returns:
        true if addition of resource to collection was successful or false if collection already contained the resource.

      • remove

        boolean remove​(Asset asset)
        Deprecated.
        Removes an Asset from image set & returns true if successful
        Parameters:
        asset - Asset to be removed
        Returns:
        true if asset was successfully removed from the collection. false otherwise

      • orderBefore

        void orderBefore​(Asset srcAsset,
                 Asset destAsset)
        Deprecated.
        Change the order of assets in image set.
        Parameters:
        srcAsset - Asset that needs to be moved in the order
        destAsset - Asset before which the srcAssetPath will be placed. destAsset is null, then srcAsset will be placed at the end of the list.
        Throws:
        java.lang.IllegalArgumentException - if asset is null or if asset or beforeAsset does not exist in set

      • getType

        java.lang.String getType()
        Deprecated.
        Returns the type of the set.
        Returns:
        type of the set i.e. ImageSet, SwatchSet