Package com.github.m0nk3y2k4.thetvdb.api.model.data

Interface Series

  • All Superinterfaces:
    SeriesSearchResult
    All Known Implementing Classes:
    SeriesDTO
    public interface Series
extends SeriesSearchResult
    Interface representing a Series data transfer object.


    The methods of this class provide easy access to all series related data which was returned by the remote service in JSON format. Please note that, as the remote service declares all of the properties to be optional, most of the methods are marked as Nullable. Methods returning collection-based values however will return an empty collection in case no corresponding data was received.


    The sole purpose of these DTO objects is to encapsulate the exact raw JSON data as received from the remote service in order to facilitate API integration by working with simple Java POJO's instead of nested JSON nodes. Although there will be no intense post-processing of the actual JSON values a type-casting may be applied to some of them to improve the usability and relieve the API user of this task.

    • Method Detail

      • getAdded

        @Nullable
String getAdded()
        Get the value of the {data.added} JSON property
        Returns:
        The added property from the received JSON

      • getAirsDayOfWeek

        @Nullable
String getAirsDayOfWeek()
        Get the value of the {data.airsDayOfWeek} JSON property
        Returns:
        The airsDayOfWeek property from the received JSON

      • getAirsTime

        @Nullable
String getAirsTime()
        Get the value of the {data.airsTime} JSON property
        Returns:
        The airsTime property from the received JSON

      • getGenre

        List<String> getGenre()
        Get all values of the {data.genre} JSON property in a list
        Returns:
        The genre property from the received JSON as list

      • getImdbId

        @Nullable
String getImdbId()
        Get the value of the {data.imdbId} JSON property
        Returns:
        The imdbId property from the received JSON

      • getLastUpdated

        @Nullable
Long getLastUpdated()
        Get the value of the {data.lastUpdated} JSON property
        Returns:
        The lastUpdated property from the received JSON

      • getNetworkId

        @Nullable
String getNetworkId()
        Get the value of the {data.networkId} JSON property
        Returns:
        The networkId property from the received JSON

      • getRating

        @Nullable
String getRating()
        Get the value of the {data.rating} JSON property
        Returns:
        The rating property from the received JSON

      • getRuntime

        @Nullable
String getRuntime()
        Get the value of the {data.runtime} JSON property
        Returns:
        The runtime property from the received JSON

      • getSeriesId

        @Nullable
String getSeriesId()
        Get the value of the {data.seriesId} JSON property
        Returns:
        The seriesId property from the received JSON

      • getSiteRating

        @Nullable
Double getSiteRating()
        Get the value of the {data.siteRating} JSON property
        Returns:
        The siteRating property from the received JSON

      • getSiteRatingCount

        @Nullable
Long getSiteRatingCount()
        Get the value of the {data.siteRatingCount} JSON property
        Returns:
        The siteRatingCount property from the received JSON

      • getZap2itId

        @Nullable
String getZap2itId()
        Get the value of the {data.zap2itId} JSON property
        Returns:
        The zap2itId property from the received JSON