Overview Package Class Tree Deprecated Index Help
com.samsung.android.penup.model

Class ArtworkResource

  • java.lang.Object
    • com.samsung.android.penup.model.ArtworkResource
  • All Implemented Interfaces:
    Resource, java.lang.Cloneable

    public final class ArtworkResource
extends java.lang.Object
implements Resource
    This class contains meta data of the artwork like a title, a description, and etc.
    Since:
    PEN.UP 1.0

    • Constructor Detail

      • ArtworkResource

        public ArtworkResource()
        Constructs an ArtworkResource instance.
        Since:
        PEN.UP 1.0

    • Method Detail

      • clone

        public ArtworkResource clone()
        Clones this object.
        Specified by:
        clone in interface Resource
        Overrides:
        clone in class java.lang.Object
        Returns:
        The cloned object
        Since:
        PEN.UP 1.0

      • getId

        public java.lang.String getId()
        Gets the artwork ID.
        Specified by:
        getId in interface Resource
        Returns:
        The artwork ID
        Since:
        PEN.UP 1.0

      • getTitle

        public java.lang.String getTitle()
        Gets the title of the artwork.
        Returns:
        The title of the artwork
        Since:
        PEN.UP 1.0

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the artwork.
        Returns:
        The description of the artwork
        Since:
        PEN.UP 1.0

      • getArtistId

        public java.lang.String getArtistId()
        Gets the artist ID.
        Returns:
        The artist ID
        Since:
        PEN.UP 1.0

      • getArtistName

        public java.lang.String getArtistName()
        Gets the artist name.
        Returns:
        The artist name
        Since:
        PEN.UP 1.0

      • getOriginalArtistId

        public java.lang.String getOriginalArtistId()
        Gets the original artist ID.
        Returns:
        The original artist ID
        Since:
        PEN.UP 1.0

      • getOriginalArtworkId

        public java.lang.String getOriginalArtworkId()
        Gets the original artwork ID.
        Returns:
        The original artwork ID
        Since:
        PEN.UP 1.0

      • getFavoriteCount

        public int getFavoriteCount()
        Gets the number of favorite.
        Returns:
        The number of favorite
        Since:
        PEN.UP 1.0

      • getImageRatio

        public double getImageRatio()
        Gets the vertical to horizontal ratio of the artwork.
        Returns:
        The vertical to horizontal ratio of the artwork
        Since:
        PEN.UP 1.0

      • getImageUrl

        public java.lang.String getImageUrl()
        Gets the image URL.
        Returns:
        The image URL
        Since:
        PEN.UP 1.0

      • getThumbnailImageUrl

        public java.lang.String getThumbnailImageUrl()
        Gets the thumbnail image URL.
        Returns:
        The thumbnail image URL
        Since:
        PEN.UP 1.0

      • getLargeThumbnailImageUrl

        public java.lang.String getLargeThumbnailImageUrl()
        Gets the large thumbnail image URL.
        Returns:
        The thumbnail image URL
        Since:
        PEN.UP 1.0

      • getCollectionId

        public java.lang.String getCollectionId()
        Gets the collection ID.
        Returns:
        The collection ID
        Since:
        PEN.UP 1.0

      • setTitle

        public void setTitle(java.lang.String title)
        Sets the title of the artwork.
        Parameters:
        title - The title of the artwork.
        The length of the title must be within 45 characters.
        Throws:
        java.lang.IllegalArgumentException - The length of title is greater than 45.
        Since:
        PEN.UP 1.0

      • setDescription

        public void setDescription(java.lang.String description)
        Sets the description of the artwork.
        Parameters:
        description - The description of the artwork.
        The length of the description must be within 500 characters.
        Throws:
        java.lang.IllegalArgumentException - The length of description is greater than 500.
        Since:
        PEN.UP 1.0

      • setCollectionId

        public void setCollectionId(java.lang.String collectionId)
        Sets the collection ID.
        Parameters:
        collectionId - The collection ID
        Since:
        PEN.UP 1.0