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

Interface SeriesSearchResult

  • All Known Subinterfaces:
    Series
    All Known Implementing Classes:
    SeriesDTO, SeriesSearchResultDTO
    public interface SeriesSearchResult
    Interface representing a Series search result data transfer object.


    The methods of this class provide easy access to all series search result 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

      • getAliases

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

      • getBanner

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

      • getFirstAired

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

      • getId

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

      • getImage

        @Nullable
String getImage()
        Get the value of the {data.image} JSON property. Only available for route [GET] /search/series.
        Returns:
        The image property from the received JSON

      • getNetwork

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

      • getOverview

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

      • getPoster

        @Nullable
String getPoster()
        Get the value of the {data.poster} JSON property. Only available for route [GET] /search/series.
        Returns:
        The poster property from the received JSON

      • getSeriesName

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

      • getSlug

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

      • getStatus

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