Package com.day.cq.dam.api.s7dam.set
Interface MediaSet
-
- All Known Subinterfaces:
CarouselSet
,ImageSet
,SwatchSet
@Deprecated @ProviderType public interface MediaSet extends Resource
Deprecated.Not for public use - this API will be replaced in a future releaseRepresents a Scene7 Media set.
-
-
Field Summary
-
Fields inherited from interface org.apache.sling.api.resource.Resource
RESOURCE_TYPE_NON_EXISTING
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
add(Asset asset)
Deprecated.Add anasset
to the image set and returns true if successful.boolean
add(Asset asset, Asset swatch)
Deprecated.Add anasset
to the image set and returns true if successful.boolean
contains(Asset asset)
Deprecated.Returns true ifasset
is part of Image Setjava.util.Iterator<Asset>
getMembers()
Deprecated.Returns an iterator over assets in the Media Setjava.lang.String
getType()
Deprecated.Returns the type of the set.boolean
isValidMemberType(Asset asset)
Deprecated.Checks if the given asset is valid member type of Media Setvoid
orderBefore(Asset srcAsset, Asset destAsset)
Deprecated.Change the order of assets in image set.boolean
remove(Asset asset)
Deprecated.Removes anAsset
from image set & returns true if successful-
Methods inherited from interface org.apache.sling.api.resource.Resource
getChild, getChildren, getName, getParent, getPath, getResourceMetadata, getResourceResolver, getResourceSuperType, getResourceType, getValueMap, hasChildren, isResourceType, listChildren
-
-
-
-
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 ifasset
is part of Image Set- Parameters:
asset
- asset instance to be checked- Returns:
true
ifasset
is part of the Image Set.false
otherwise
-
add
boolean add(Asset asset)
Deprecated.Add anasset
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 anasset
to the image set and returns true if successful.
-
remove
boolean remove(Asset asset)
Deprecated.Removes anAsset
from image set & returns true if successful- Parameters:
asset
-Asset
to be removed- Returns:
true
ifasset
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 orderdestAsset
-Asset
before which thesrcAssetPath
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 ifasset
orbeforeAsset
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
-
-