From b62d788414f0b74c5ab9ab03ecc323021687560a Mon Sep 17 00:00:00 2001 From: Stuart Boston Date: Sun, 22 Dec 2013 18:47:12 +0100 Subject: [PATCH] Wagon: Deploying site to repository --- apidocs/allclasses-frame.html | 277 +- apidocs/allclasses-noframe.html | 277 +- ...MovieDbException.MovieDbExceptionType.html | 799 +-- .../themoviedbapi/MovieDbException.html | 615 +- .../omertron/themoviedbapi/TheMovieDbApi.html | 4119 ++++++------ ...MovieDbException.MovieDbExceptionType.html | 382 +- .../class-use/MovieDbException.html | 1517 +++-- .../class-use/TheMovieDbApi.html | 236 +- .../model/AbstractJsonMapping.html | 552 +- .../omertron/themoviedbapi/model/Account.html | 857 +-- .../themoviedbapi/model/AlternativeTitle.html | 674 +- .../omertron/themoviedbapi/model/Artwork.html | 1136 ++-- .../themoviedbapi/model/ArtworkType.html | 629 +- .../themoviedbapi/model/ChangeKeyItem.html | 637 +- .../themoviedbapi/model/ChangedItem.html | 861 +-- .../themoviedbapi/model/ChangedMovie.html | 601 +- .../themoviedbapi/model/Collection.html | 939 +-- .../themoviedbapi/model/CollectionInfo.html | 861 +-- .../omertron/themoviedbapi/model/Company.html | 970 +-- .../themoviedbapi/model/Discover.html | 1073 ++-- .../omertron/themoviedbapi/model/Genre.html | 683 +- .../themoviedbapi/model/JobDepartment.html | 601 +- .../omertron/themoviedbapi/model/Keyword.html | 683 +- .../themoviedbapi/model/KeywordMovie.html | 1149 ++-- .../themoviedbapi/model/Language.html | 683 +- .../themoviedbapi/model/ListItemStatus.html | 605 +- .../omertron/themoviedbapi/model/MovieDb.html | 2768 ++++---- .../themoviedbapi/model/MovieDbList.html | 1186 ++-- .../model/MovieDbListStatus.html | 559 +- .../themoviedbapi/model/MovieList.html | 989 +-- .../omertron/themoviedbapi/model/Person.html | 1751 +++--- .../themoviedbapi/model/PersonCast.html | 939 +-- .../themoviedbapi/model/PersonCredit.html | 1117 ++-- .../themoviedbapi/model/PersonCrew.html | 875 +-- .../themoviedbapi/model/PersonType.html | 630 +- .../model/ProductionCompany.html | 683 +- .../model/ProductionCountry.html | 683 +- .../themoviedbapi/model/ReleaseInfo.html | 747 +-- .../omertron/themoviedbapi/model/Reviews.html | 733 +-- .../themoviedbapi/model/StatusCode.html | 612 +- .../model/TmdbConfiguration.html | 1099 ++-- .../model/TokenAuthorisation.html | 665 +- .../themoviedbapi/model/TokenSession.html | 857 +-- .../omertron/themoviedbapi/model/Trailer.html | 976 +-- .../themoviedbapi/model/Translation.html | 786 +-- .../model/class-use/AbstractJsonMapping.html | 1037 +-- .../model/class-use/Account.html | 314 +- .../model/class-use/AlternativeTitle.html | 449 +- .../model/class-use/Artwork.html | 541 +- .../model/class-use/ArtworkType.html | 424 +- .../model/class-use/ChangeKeyItem.html | 341 +- .../model/class-use/ChangedItem.html | 398 +- .../model/class-use/ChangedMovie.html | 398 +- .../model/class-use/Collection.html | 536 +- .../model/class-use/CollectionInfo.html | 316 +- .../model/class-use/Company.html | 507 +- .../model/class-use/Discover.html | 551 +- .../themoviedbapi/model/class-use/Genre.html | 474 +- .../model/class-use/JobDepartment.html | 392 +- .../model/class-use/Keyword.html | 518 +- .../model/class-use/KeywordMovie.html | 398 +- .../model/class-use/Language.html | 341 +- .../model/class-use/ListItemStatus.html | 236 +- .../model/class-use/MovieDb.html | 862 +-- .../model/class-use/MovieDbList.html | 427 +- .../model/class-use/MovieDbListStatus.html | 236 +- .../model/class-use/MovieList.html | 469 +- .../themoviedbapi/model/class-use/Person.html | 525 +- .../model/class-use/PersonCast.html | 392 +- .../model/class-use/PersonCredit.html | 503 +- .../model/class-use/PersonCrew.html | 392 +- .../model/class-use/PersonType.html | 446 +- .../model/class-use/ProductionCompany.html | 341 +- .../model/class-use/ProductionCountry.html | 341 +- .../model/class-use/ReleaseInfo.html | 449 +- .../model/class-use/Reviews.html | 449 +- .../model/class-use/StatusCode.html | 455 +- .../model/class-use/TmdbConfiguration.html | 447 +- .../model/class-use/TokenAuthorisation.html | 345 +- .../model/class-use/TokenSession.html | 328 +- .../model/class-use/Trailer.html | 487 +- .../model/class-use/Translation.html | 447 +- .../PersonCreditDateComparator.html | 597 +- .../class-use/PersonCreditDateComparator.html | 236 +- .../model/comparator/package-frame.html | 51 +- .../model/comparator/package-summary.html | 269 +- .../model/comparator/package-tree.html | 259 +- .../model/comparator/package-use.html | 236 +- .../themoviedbapi/model/package-frame.html | 171 +- .../themoviedbapi/model/package-summary.html | 592 +- .../themoviedbapi/model/package-tree.html | 327 +- .../themoviedbapi/model/package-use.html | 1095 ++-- .../omertron/themoviedbapi/package-frame.html | 81 +- .../themoviedbapi/package-summary.html | 327 +- .../omertron/themoviedbapi/package-tree.html | 294 +- .../omertron/themoviedbapi/package-use.html | 342 +- .../results/AbstractResults.html | 862 +-- .../results/TmdbResultsList.html | 580 +- .../themoviedbapi/results/TmdbResultsMap.html | 580 +- .../results/class-use/AbstractResults.html | 328 +- .../results/class-use/TmdbResultsList.html | 876 +-- .../results/class-use/TmdbResultsMap.html | 318 +- .../themoviedbapi/results/package-frame.html | 57 +- .../results/package-summary.html | 289 +- .../themoviedbapi/results/package-tree.html | 265 +- .../themoviedbapi/results/package-use.html | 348 +- .../omertron/themoviedbapi/tools/ApiUrl.html | 1375 ++-- .../themoviedbapi/tools/WebBrowser.html | 1036 +-- .../themoviedbapi/tools/class-use/ApiUrl.html | 236 +- .../tools/class-use/WebBrowser.html | 236 +- .../themoviedbapi/tools/package-frame.html | 54 +- .../themoviedbapi/tools/package-summary.html | 279 +- .../themoviedbapi/tools/package-tree.html | 259 +- .../themoviedbapi/tools/package-use.html | 236 +- .../wrapper/AbstractWrapper.html | 539 +- .../wrapper/AbstractWrapperAll.html | 862 +-- .../wrapper/AbstractWrapperId.html | 590 +- .../themoviedbapi/wrapper/IWrapperDates.html | 420 +- .../themoviedbapi/wrapper/IWrapperId.html | 420 +- .../themoviedbapi/wrapper/IWrapperPages.html | 548 +- .../themoviedbapi/wrapper/ResultDates.html | 680 +- .../wrapper/WrapperAlternativeTitles.html | 592 +- .../themoviedbapi/wrapper/WrapperChanges.html | 612 +- .../wrapper/WrapperCollection.html | 623 +- .../themoviedbapi/wrapper/WrapperCompany.html | 623 +- .../wrapper/WrapperCompanyMovies.html | 623 +- .../themoviedbapi/wrapper/WrapperConfig.html | 627 +- .../themoviedbapi/wrapper/WrapperGenres.html | 568 +- .../themoviedbapi/wrapper/WrapperImages.html | 843 +-- .../themoviedbapi/wrapper/WrapperJobList.html | 563 +- .../wrapper/WrapperKeywordMovies.html | 623 +- .../wrapper/WrapperKeywords.html | 623 +- .../themoviedbapi/wrapper/WrapperMovie.html | 630 +- .../wrapper/WrapperMovieCasts.html | 697 ++- .../wrapper/WrapperMovieChanges.html | 619 +- .../wrapper/WrapperMovieDbList.html | 619 +- .../wrapper/WrapperMovieKeywords.html | 592 +- .../wrapper/WrapperMovieList.html | 630 +- .../themoviedbapi/wrapper/WrapperPerson.html | 623 +- .../wrapper/WrapperPersonCredits.html | 719 +-- .../wrapper/WrapperPersonList.html | 623 +- .../wrapper/WrapperReleaseInfo.html | 592 +- .../themoviedbapi/wrapper/WrapperReviews.html | 630 +- .../wrapper/WrapperTrailers.html | 704 ++- .../wrapper/WrapperTranslations.html | 592 +- .../wrapper/class-use/AbstractWrapper.html | 657 +- .../wrapper/class-use/AbstractWrapperAll.html | 521 +- .../wrapper/class-use/AbstractWrapperId.html | 607 +- .../wrapper/class-use/IWrapperDates.html | 482 +- .../wrapper/class-use/IWrapperId.html | 568 +- .../wrapper/class-use/IWrapperPages.html | 482 +- .../wrapper/class-use/ResultDates.html | 365 +- .../class-use/WrapperAlternativeTitles.html | 312 +- .../wrapper/class-use/WrapperChanges.html | 236 +- .../wrapper/class-use/WrapperCollection.html | 236 +- .../wrapper/class-use/WrapperCompany.html | 236 +- .../class-use/WrapperCompanyMovies.html | 236 +- .../wrapper/class-use/WrapperConfig.html | 236 +- .../wrapper/class-use/WrapperGenres.html | 236 +- .../wrapper/class-use/WrapperImages.html | 312 +- .../wrapper/class-use/WrapperJobList.html | 236 +- .../class-use/WrapperKeywordMovies.html | 236 +- .../wrapper/class-use/WrapperKeywords.html | 236 +- .../wrapper/class-use/WrapperMovie.html | 312 +- .../wrapper/class-use/WrapperMovieCasts.html | 312 +- .../class-use/WrapperMovieChanges.html | 236 +- .../wrapper/class-use/WrapperMovieDbList.html | 236 +- .../class-use/WrapperMovieKeywords.html | 312 +- .../wrapper/class-use/WrapperMovieList.html | 312 +- .../wrapper/class-use/WrapperPerson.html | 236 +- .../class-use/WrapperPersonCredits.html | 236 +- .../wrapper/class-use/WrapperPersonList.html | 236 +- .../wrapper/class-use/WrapperReleaseInfo.html | 312 +- .../wrapper/class-use/WrapperReviews.html | 312 +- .../wrapper/class-use/WrapperTrailers.html | 312 +- .../class-use/WrapperTranslations.html | 312 +- .../themoviedbapi/wrapper/package-frame.html | 153 +- .../wrapper/package-summary.html | 534 +- .../themoviedbapi/wrapper/package-tree.html | 332 +- .../themoviedbapi/wrapper/package-use.html | 532 +- apidocs/constant-values.html | 542 +- apidocs/deprecated-list.html | 238 +- apidocs/help-doc.html | 420 +- apidocs/index-all.html | 4681 +++++++------- apidocs/index.html | 54 +- apidocs/overview-frame.html | 77 +- apidocs/overview-summary.html | 302 +- apidocs/overview-tree.html | 427 +- apidocs/serialized-form.html | 5569 +++++++++++------ apidocs/stylesheet.css | 501 +- dependencies.html | 42 +- index.html | 2 +- issue-tracking.html | 2 +- license.html | 2 +- project-info.html | 2 +- project-reports.html | 2 +- project-summary.html | 4 +- source-repository.html | 2 +- testapidocs/allclasses-frame.html | 52 +- testapidocs/allclasses-noframe.html | 52 +- .../omertron/themoviedbapi/TestLogger.html | 453 +- .../themoviedbapi/TheMovieDbApiTest.html | 3355 +++++----- .../themoviedbapi/class-use/TestLogger.html | 232 +- .../class-use/TheMovieDbApiTest.html | 232 +- .../omertron/themoviedbapi/package-frame.html | 54 +- .../themoviedbapi/package-summary.html | 273 +- .../omertron/themoviedbapi/package-tree.html | 248 +- .../omertron/themoviedbapi/package-use.html | 232 +- testapidocs/constant-values.html | 234 +- testapidocs/deprecated-list.html | 234 +- testapidocs/help-doc.html | 406 +- testapidocs/index-all.html | 763 ++- testapidocs/index.html | 48 +- testapidocs/overview-tree.html | 254 +- testapidocs/stylesheet.css | 501 +- 215 files changed, 65372 insertions(+), 56700 deletions(-) diff --git a/apidocs/allclasses-frame.html b/apidocs/allclasses-frame.html index fdc6138f3..2c6a4ce99 100644 --- a/apidocs/allclasses-frame.html +++ b/apidocs/allclasses-frame.html @@ -1,95 +1,184 @@ - - - - - -All Classes (API-The MovieDB 3.9 API) - - - - -

All Classes

-
- -
- - + + + + + + +All Classes (API-The MovieDB 3.10-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractJsonMapping +
+AbstractResults +
+AbstractWrapper +
+AbstractWrapperAll +
+AbstractWrapperId +
+Account +
+AlternativeTitle +
+ApiUrl +
+Artwork +
+ArtworkType +
+ChangedItem +
+ChangedMovie +
+ChangeKeyItem +
+Collection +
+CollectionInfo +
+Company +
+Discover +
+Genre +
+IWrapperDates +
+IWrapperId +
+IWrapperPages +
+JobDepartment +
+Keyword +
+KeywordMovie +
+Language +
+ListItemStatus +
+MovieDb +
+MovieDbException +
+MovieDbException.MovieDbExceptionType +
+MovieDbList +
+MovieDbListStatus +
+MovieList +
+Person +
+PersonCast +
+PersonCredit +
+PersonCreditDateComparator +
+PersonCrew +
+PersonType +
+ProductionCompany +
+ProductionCountry +
+ReleaseInfo +
+ResultDates +
+Reviews +
+StatusCode +
+TheMovieDbApi +
+TmdbConfiguration +
+TmdbResultsList +
+TmdbResultsMap +
+TokenAuthorisation +
+TokenSession +
+Trailer +
+Translation +
+WebBrowser +
+WrapperAlternativeTitles +
+WrapperChanges +
+WrapperCollection +
+WrapperCompany +
+WrapperCompanyMovies +
+WrapperConfig +
+WrapperGenres +
+WrapperImages +
+WrapperJobList +
+WrapperKeywordMovies +
+WrapperKeywords +
+WrapperMovie +
+WrapperMovieCasts +
+WrapperMovieChanges +
+WrapperMovieDbList +
+WrapperMovieKeywords +
+WrapperMovieList +
+WrapperPerson +
+WrapperPersonCredits +
+WrapperPersonList +
+WrapperReleaseInfo +
+WrapperReviews +
+WrapperTrailers +
+WrapperTranslations +
+
+ + + diff --git a/apidocs/allclasses-noframe.html b/apidocs/allclasses-noframe.html index 1d7e7c8a8..00d75bf0b 100644 --- a/apidocs/allclasses-noframe.html +++ b/apidocs/allclasses-noframe.html @@ -1,95 +1,184 @@ - - - - - -All Classes (API-The MovieDB 3.9 API) - - - - -

All Classes

-
- -
- - + + + + + + +All Classes (API-The MovieDB 3.10-SNAPSHOT API) + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractJsonMapping +
+AbstractResults +
+AbstractWrapper +
+AbstractWrapperAll +
+AbstractWrapperId +
+Account +
+AlternativeTitle +
+ApiUrl +
+Artwork +
+ArtworkType +
+ChangedItem +
+ChangedMovie +
+ChangeKeyItem +
+Collection +
+CollectionInfo +
+Company +
+Discover +
+Genre +
+IWrapperDates +
+IWrapperId +
+IWrapperPages +
+JobDepartment +
+Keyword +
+KeywordMovie +
+Language +
+ListItemStatus +
+MovieDb +
+MovieDbException +
+MovieDbException.MovieDbExceptionType +
+MovieDbList +
+MovieDbListStatus +
+MovieList +
+Person +
+PersonCast +
+PersonCredit +
+PersonCreditDateComparator +
+PersonCrew +
+PersonType +
+ProductionCompany +
+ProductionCountry +
+ReleaseInfo +
+ResultDates +
+Reviews +
+StatusCode +
+TheMovieDbApi +
+TmdbConfiguration +
+TmdbResultsList +
+TmdbResultsMap +
+TokenAuthorisation +
+TokenSession +
+Trailer +
+Translation +
+WebBrowser +
+WrapperAlternativeTitles +
+WrapperChanges +
+WrapperCollection +
+WrapperCompany +
+WrapperCompanyMovies +
+WrapperConfig +
+WrapperGenres +
+WrapperImages +
+WrapperJobList +
+WrapperKeywordMovies +
+WrapperKeywords +
+WrapperMovie +
+WrapperMovieCasts +
+WrapperMovieChanges +
+WrapperMovieDbList +
+WrapperMovieKeywords +
+WrapperMovieList +
+WrapperPerson +
+WrapperPersonCredits +
+WrapperPersonList +
+WrapperReleaseInfo +
+WrapperReviews +
+WrapperTrailers +
+WrapperTranslations +
+
+ + + diff --git a/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html b/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html index 5db72480e..7aa5d84b6 100644 --- a/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html +++ b/apidocs/com/omertron/themoviedbapi/MovieDbException.MovieDbExceptionType.html @@ -1,411 +1,438 @@ - - - - - -MovieDbException.MovieDbExceptionType (API-The MovieDB 3.9 API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD + +DETAIL: ENUM CONSTANTS | FIELD | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Enum MovieDbException.MovieDbExceptionType

-
-
- -
- -
-
- -
-
- -
-
+not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+ +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD + +DETAIL: ENUM CONSTANTS | FIELD | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/MovieDbException.html b/apidocs/com/omertron/themoviedbapi/MovieDbException.html index ee02b33c6..87985259e 100644 --- a/apidocs/com/omertron/themoviedbapi/MovieDbException.html +++ b/apidocs/com/omertron/themoviedbapi/MovieDbException.html @@ -1,330 +1,325 @@ - - - - - -MovieDbException (API-The MovieDB 3.9 API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Class MovieDbException

-
-
- -
- -
-
- -
-
- -
-
+ + + + + + +
+Method Detail
+ +

+getExceptionType

+
+public MovieDbException.MovieDbExceptionType getExceptionType()
+
+
+
+
+
+
+ +

+getResponse

+
+public String getResponse()
+
+
+
+
+
+
+ + -
- - - - - -
-
- - - -
- -
-
- - -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html b/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html index 33d294b1a..23fc905e4 100644 --- a/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html +++ b/apidocs/com/omertron/themoviedbapi/TheMovieDbApi.html @@ -1,863 +1,1036 @@ - - - - - -TheMovieDbApi (API-The MovieDB 3.9 API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + + +
-
-
com.omertron.themoviedbapi
-

Class TheMovieDbApi

-
-
- -
-
    -
  • -
    -
    -
    public class TheMovieDbApi
-extends Object
    -
    The MovieDb API +

    + +com.omertron.themoviedbapi +
    +Class TheMovieDbApi

    +
    +java.lang.Object
+  extended by com.omertron.themoviedbapi.TheMovieDbApi
+
    +
    +
    +
    public class TheMovieDbApi
    extends Object
    + + +

    +The MovieDb API

    - This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3

    -
    Author:
    -
    stuart.boston
    -
    • -
-
-
-
    -
  • + This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3 +

    + +

    +

    +
    Author:
    +
    stuart.boston
    +
    +
    + +

    + -

      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      TheMovieDbApi(String apiKey) -
      API for The Movie Db.
      -
      TheMovieDbApi(String apiKey, - org.yamj.api.common.http.CommonHttpClient httpClient) -
      API for The Movie Db.
      -
      -
      • -
    + + + + + + + + + + + + +
    +Constructor Summary
    TheMovieDbApi(String apiKey) + +
    +          API for The Movie Db.
    TheMovieDbApi(String apiKey, + org.yamj.api.common.http.CommonHttpClient httpClient) + +
    +          API for The Movie Db.
    +  -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StatusCodeaddMovieToList(String sessionId, - String listId, - Integer movieId) -
      This method lets users add new movies to a list that they created.
      -
      StatusCodeaddToWatchList(String sessionId, - int accountId, - Integer movieId) -
      Add a movie to an accounts watch list.
      -
      StatusCodechangeFavoriteStatus(String sessionId, - int accountId, - Integer movieId, - boolean isFavorite) 
      static booleancompareMovies(MovieDb moviedb, - String title, - String year) -
      Compare the MovieDB object with a title & year
      -
      static booleancompareMovies(MovieDb moviedb, - String title, - String year, - int maxDistance) -
      Compare the MovieDB object with a title & year
      -
      static StringconvertToJson(Map<String,?> map) -
      Use Jackson to convert Map to JSON string.
      -
      URLcreateImageUrl(String imagePath, - String requiredSize) -
      Generate the full image URL from the size and image path
      -
      StringcreateList(String sessionId, - String name, - String description) -
      This method lets users create a new list.
      -
      StatusCodedeleteMovieList(String sessionId, - String listId) -
      This method lets users delete a list that they created.
      -
      AccountgetAccount(String sessionId) -
      Get the basic information for an account.
      -
      StringgetApiKey() -
      Get the API key that is to be used
      -
      TokenAuthorisationgetAuthorisationToken() -
      This method is used to generate a valid request token for user based authentication.
      -
      TmdbResultsList<Artwork>getCollectionImages(int collectionId, - String language) -
      Get all of the images for a particular collection by collection id.
      -
      CollectionInfogetCollectionInfo(int collectionId, - String language) -
      This method is used to retrieve all of the basic information about a movie collection.
      -
      CompanygetCompanyInfo(int companyId) -
      This method is used to retrieve the basic information about a production company on TMDb.
      -
      TmdbResultsList<MovieDb>getCompanyMovies(int companyId, - String language, - int page) -
      This method is used to retrieve the movies associated with a company.
      -
      TmdbConfigurationgetConfiguration() -
      Get the configuration information
      -
      TmdbResultsList<MovieDb>getDiscover(Discover discover) -
      Discover movies by different types of data like average rating, number of votes, genres and certifications.
      -
      TmdbResultsList<MovieDb>getDiscover(int page, - String language, - String sortBy, - boolean includeAdult, - int year, - int primaryReleaseYear, - int voteCountGte, - float voteAverageGte, - String withGenres, - String releaseDateGte, - String releaseDateLte, - String certificationCountry, - String certificationLte, - String withCompanies) -
      Discover movies by different types of data like average rating, number of votes, genres and certifications.
      -
      List<MovieDb>getFavoriteMovies(String sessionId, - int accountId) 
      TmdbResultsList<Genre>getGenreList(String language) -
      You can use this method to retrieve the list of genres used on TMDb.
      -
      TmdbResultsList<MovieDb>getGenreMovies(int genreId, - String language, - int page, - boolean includeAllMovies) -
      Get a list of movies per genre.
      -
      TokenSessiongetGuestSessionToken() -
      This method is used to generate a guest session id.
      -
      TmdbResultsList<JobDepartment>getJobs() 
      KeywordgetKeyword(String keywordId) -
      Get the basic information for a specific keyword id.
      -
      TmdbResultsList<KeywordMovie>getKeywordMovies(String keywordId, - String language, - int page) -
      Get the list of movies for a particular keyword by id.
      -
      MovieDbgetLatestMovie() -
      This method is used to retrieve the newest movie that was added to TMDb.
      -
      MovieDbListgetList(String listId) -
      Get a list by its ID
      -
      TmdbResultsList<AlternativeTitle>getMovieAlternativeTitles(int movieId, - String country, - String... appendToResponse) -
      This method is used to retrieve all of the alternative titles we have for a particular movie.
      -
      TmdbResultsList<Person>getMovieCasts(int movieId, - String... appendToResponse) -
      Get the cast information for a specific movie id.
      -
      TmdbResultsMap<String,List<ChangedItem>>getMovieChanges(int movieId, - String startDate, - String endDate) -
      Get the changes for a specific movie id.
      -
      TmdbResultsList<ChangedMovie>getMovieChangesList(int page, - String startDate, - String endDate) -
      Get a list of movie ids that have been edited.
      -
      TmdbResultsList<Artwork>getMovieImages(int movieId, - String language, - String... appendToResponse) -
      This method should be used when you’re wanting to retrieve all of the images for a particular movie.
      -
      MovieDbgetMovieInfo(int movieId, - String language, - String... appendToResponse) -
      This method is used to retrieve all of the basic movie information.
      -
      MovieDbgetMovieInfoImdb(String imdbId, - String language, - String... appendToResponse) -
      This method is used to retrieve all of the basic movie information.
      -
      TmdbResultsList<Keyword>getMovieKeywords(int movieId, - String... appendToResponse) -
      This method is used to retrieve all of the keywords that have been added to a particular movie.
      -
      TmdbResultsList<MovieList>getMovieLists(int movieId, - String language, - int page, - String... appendToResponse) -
      Get the lists that the movie belongs to
      -
      TmdbResultsList<ReleaseInfo>getMovieReleaseInfo(int movieId, - String language, - String... appendToResponse) -
      This method is used to retrieve all of the release and certification data we have for a specific movie.
      -
      TmdbResultsList<Trailer>getMovieTrailers(int movieId, - String language, - String... appendToResponse) -
      This method is used to retrieve all of the trailers for a particular movie.
      -
      TmdbResultsList<Translation>getMovieTranslations(int movieId, - String... appendToResponse) -
      This method is used to retrieve a list of the available translations for a specific movie.
      -
      TmdbResultsList<MovieDb>getNowPlayingMovies(String language, - int page) -
      This method is used to retrieve the movies currently in theatres.
      -
      voidgetPersonChanges(int personId, - String startDate, - String endDate) -
      Get the changes for a specific person id.
      -
      voidgetPersonChangesList(int page, - String startDate, - String endDate) 
      TmdbResultsList<PersonCredit>getPersonCredits(int personId, - String... appendToResponse) -
      This method is used to retrieve all of the cast & crew information for the person.
      -
      TmdbResultsList<Artwork>getPersonImages(int personId) -
      This method is used to retrieve all of the profile images for a person.
      -
      PersongetPersonInfo(int personId, - String... appendToResponse) -
      This method is used to retrieve all of the basic person information.
      -
      PersongetPersonLatest() -
      Get the latest person id.
      -
      TmdbResultsList<Person>getPersonPopular() -
      Get the list of popular people on The Movie Database.
      -
      TmdbResultsList<Person>getPersonPopular(int page) -
      Get the list of popular people on The Movie Database.
      -
      TmdbResultsList<MovieDb>getPopularMovieList(String language, - int page) -
      This method is used to retrieve the daily movie popularity list.
      -
      List<MovieDb>getRatedMovies(String sessionId, - int accountId) -
      Get the list of rated movies (and associated rating) for an account.
      -
      TmdbResultsList<Reviews>getReviews(int movieId, - String language, - int page, - String... appendToResponse) 
      TokenSessiongetSessionToken(TokenAuthorisation token) -
      This method is used to generate a session id for user based authentication.
      -
      TmdbResultsList<MovieDb>getSimilarMovies(int movieId, - String language, - int page, - String... appendToResponse) -
      The similar movies method will let you retrieve the similar movies for a particular movie.
      -
      TmdbResultsList<MovieDb>getTopRatedMovies(String language, - int page) -
      This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
      -
      TmdbResultsList<MovieDb>getUpcoming(String language, - int page) -
      Get the list of upcoming movies.
      -
      List<MovieDbList>getUserLists(String sessionId, - int accountID) -
      Get all lists of a given user
      -
      List<MovieDb>getWatchList(String sessionId, - int accountId) -
      Get the list of movies on an accounts watchlist.
      -
      booleanisMovieOnList(String listId, - Integer movieId) -
      Check to see if a movie ID is already added to a list.
      -
      booleanpostMovieRating(String sessionId, - Integer movieId, - Integer rating) -
      This method lets users rate a movie.
      -
      StatusCoderemoveFromWatchList(String sessionId, - int accountId, - Integer movieId) -
      Remove a movie from an accounts watch list.
      -
      StatusCoderemoveMovieFromList(String sessionId, - String listId, - Integer movieId) -
      This method lets users remove movies from a list that they created.
      -
      TmdbResultsList<Collection>searchCollection(String query, - String language, - int page) -
      Search for collections by name.
      -
      TmdbResultsList<Company>searchCompanies(String companyName, - int page) -
      Search Companies.
      -
      TmdbResultsList<Keyword>searchKeyword(String query, - int page) -
      Search for keywords by name
      -
      TmdbResultsList<MovieList>searchList(String query, - String language, - int page) -
      Search for lists by name and description.
      -
      TmdbResultsList<MovieDb>searchMovie(String movieName, - int searchYear, - String language, - boolean includeAdult, - int page) -
      Search Movies This is a good starting point to start finding movies on TMDb.
      -
      TmdbResultsList<Person>searchPeople(String personName, + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - -
      +Method Summary
      + StatusCodeaddMovieToList(String sessionId, + String listId, + Integer movieId) + +
      +          This method lets users add new movies to a list that they created.
      + StatusCodeaddToWatchList(String sessionId, + int accountId, + Integer movieId) + +
      +          Add a movie to an accounts watch list.
      + StatusCodechangeFavoriteStatus(String sessionId, + int accountId, + Integer movieId, + boolean isFavorite) + +
      +           
      +static booleancompareMovies(MovieDb moviedb, + String title, + String year) + +
      +          Compare the MovieDB object with a title & year
      +static booleancompareMovies(MovieDb moviedb, + String title, + String year, + int maxDistance) + +
      +          Compare the MovieDB object with a title & year
      +static StringconvertToJson(Map<String,?> map) + +
      +          Use Jackson to convert Map to JSON string.
      + URLcreateImageUrl(String imagePath, + String requiredSize) + +
      +          Generate the full image URL from the size and image path
      + StringcreateList(String sessionId, + String name, + String description) + +
      +          This method lets users create a new list.
      + StatusCodedeleteMovieList(String sessionId, + String listId) + +
      +          This method lets users delete a list that they created.
      + AccountgetAccount(String sessionId) + +
      +          Get the basic information for an account.
      + StringgetApiKey() + +
      +          Get the API key that is to be used
      + TokenAuthorisationgetAuthorisationToken() + +
      +          This method is used to generate a valid request token for user based authentication.
      + TmdbResultsList<Artwork>getCollectionImages(int collectionId, + String language) + +
      +          Get all of the images for a particular collection by collection id.
      + CollectionInfogetCollectionInfo(int collectionId, + String language) + +
      +          This method is used to retrieve all of the basic information about a movie collection.
      + CompanygetCompanyInfo(int companyId) + +
      +          This method is used to retrieve the basic information about a production company on TMDb.
      + TmdbResultsList<MovieDb>getCompanyMovies(int companyId, + String language, + int page) + +
      +          This method is used to retrieve the movies associated with a company.
      + TmdbConfigurationgetConfiguration() + +
      +          Get the configuration information
      + TmdbResultsList<MovieDb>getDiscover(Discover discover) + +
      +          Discover movies by different types of data like average rating, number of votes, genres and certifications.
      + TmdbResultsList<MovieDb>getDiscover(int page, + String language, + String sortBy, boolean includeAdult, - int page) -
      This is a good starting point to start finding people on TMDb.
      -
      voidsetProxy(String host, - int port, - String username, - String password) -
      Set the proxy information
      -
      voidsetTimeout(int connect, - int read) -
      Set the connection and read time out values
      -
      - - - - - - -
      -
        -
      • + int year, + int primaryReleaseYear, + int voteCountGte, + float voteAverageGte, + String withGenres, + String releaseDateGte, + String releaseDateLte, + String certificationCountry, + String certificationLte, + String withCompanies) + +
        +          Discover movies by different types of data like average rating, number of votes, genres and certifications.
      + List<MovieDb>getFavoriteMovies(String sessionId, + int accountId) + +
      +           
      + TmdbResultsList<Genre>getGenreList(String language) + +
      +          You can use this method to retrieve the list of genres used on TMDb.
      + TmdbResultsList<MovieDb>getGenreMovies(int genreId, + String language, + int page, + boolean includeAllMovies) + +
      +          Get a list of movies per genre.
      + TokenSessiongetGuestSessionToken() + +
      +          This method is used to generate a guest session id.
      + TmdbResultsList<JobDepartment>getJobs() + +
      +           
      + KeywordgetKeyword(String keywordId) + +
      +          Get the basic information for a specific keyword id.
      + TmdbResultsList<KeywordMovie>getKeywordMovies(String keywordId, + String language, + int page) + +
      +          Get the list of movies for a particular keyword by id.
      + MovieDbgetLatestMovie() + +
      +          This method is used to retrieve the newest movie that was added to TMDb.
      + MovieDbListgetList(String listId) + +
      +          Get a list by its ID
      + TmdbResultsList<AlternativeTitle>getMovieAlternativeTitles(int movieId, + String country, + String... appendToResponse) + +
      +          This method is used to retrieve all of the alternative titles we have for a particular movie.
      + TmdbResultsList<Person>getMovieCasts(int movieId, + String... appendToResponse) + +
      +          Get the cast information for a specific movie id.
      + TmdbResultsMap<String,List<ChangedItem>>getMovieChanges(int movieId, + String startDate, + String endDate) + +
      +          Get the changes for a specific movie id.
      + TmdbResultsList<ChangedMovie>getMovieChangesList(int page, + String startDate, + String endDate) + +
      +          Get a list of movie ids that have been edited.
      + TmdbResultsList<Artwork>getMovieImages(int movieId, + String language, + String... appendToResponse) + +
      +          This method should be used when you’re wanting to retrieve all of the images for a particular movie.
      + MovieDbgetMovieInfo(int movieId, + String language, + String... appendToResponse) + +
      +          This method is used to retrieve all of the basic movie information.
      + MovieDbgetMovieInfoImdb(String imdbId, + String language, + String... appendToResponse) + +
      +          This method is used to retrieve all of the basic movie information.
      + TmdbResultsList<Keyword>getMovieKeywords(int movieId, + String... appendToResponse) + +
      +          This method is used to retrieve all of the keywords that have been added to a particular movie.
      + TmdbResultsList<MovieList>getMovieLists(int movieId, + String language, + int page, + String... appendToResponse) + +
      +          Get the lists that the movie belongs to
      + TmdbResultsList<ReleaseInfo>getMovieReleaseInfo(int movieId, + String language, + String... appendToResponse) + +
      +          This method is used to retrieve all of the release and certification data we have for a specific movie.
      + TmdbResultsList<Trailer>getMovieTrailers(int movieId, + String language, + String... appendToResponse) + +
      +          This method is used to retrieve all of the trailers for a particular movie.
      + TmdbResultsList<Translation>getMovieTranslations(int movieId, + String... appendToResponse) + +
      +          This method is used to retrieve a list of the available translations for a specific movie.
      + TmdbResultsList<MovieDb>getNowPlayingMovies(String language, + int page) + +
      +          This method is used to retrieve the movies currently in theatres.
      + voidgetPersonChanges(int personId, + String startDate, + String endDate) + +
      +          Get the changes for a specific person id.
      + voidgetPersonChangesList(int page, + String startDate, + String endDate) + +
      +           
      + TmdbResultsList<PersonCredit>getPersonCredits(int personId, + String... appendToResponse) + +
      +          This method is used to retrieve all of the cast & crew information for the person.
      + TmdbResultsList<Artwork>getPersonImages(int personId) + +
      +          This method is used to retrieve all of the profile images for a person.
      + PersongetPersonInfo(int personId, + String... appendToResponse) + +
      +          This method is used to retrieve all of the basic person information.
      + PersongetPersonLatest() + +
      +          Get the latest person id.
      + TmdbResultsList<Person>getPersonPopular() + +
      +          Get the list of popular people on The Movie Database.
      + TmdbResultsList<Person>getPersonPopular(int page) + +
      +          Get the list of popular people on The Movie Database.
      + TmdbResultsList<MovieDb>getPopularMovieList(String language, + int page) + +
      +          This method is used to retrieve the daily movie popularity list.
      + List<MovieDb>getRatedMovies(String sessionId, + int accountId) + +
      +          Get the list of rated movies (and associated rating) for an account.
      + TmdbResultsList<Reviews>getReviews(int movieId, + String language, + int page, + String... appendToResponse) + +
      +           
      + TokenSessiongetSessionToken(TokenAuthorisation token) + +
      +          This method is used to generate a session id for user based authentication.
      + TmdbResultsList<MovieDb>getSimilarMovies(int movieId, + String language, + int page, + String... appendToResponse) + +
      +          The similar movies method will let you retrieve the similar movies for a particular movie.
      + TmdbResultsList<MovieDb>getTopRatedMovies(String language, + int page) + +
      +          This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
      + TmdbResultsList<MovieDb>getUpcoming(String language, + int page) + +
      +          Get the list of upcoming movies.
      + List<MovieDbList>getUserLists(String sessionId, + int accountID) + +
      +          Get all lists of a given user
      + List<MovieDb>getWatchList(String sessionId, + int accountId) + +
      +          Get the list of movies on an accounts watchlist.
      + booleanisMovieOnList(String listId, + Integer movieId) + +
      +          Check to see if a movie ID is already added to a list.
      + booleanpostMovieRating(String sessionId, + Integer movieId, + Integer rating) + +
      +          This method lets users rate a movie.
      + StatusCoderemoveFromWatchList(String sessionId, + int accountId, + Integer movieId) + +
      +          Remove a movie from an accounts watch list.
      + StatusCoderemoveMovieFromList(String sessionId, + String listId, + Integer movieId) + +
      +          This method lets users remove movies from a list that they created.
      + TmdbResultsList<Collection>searchCollection(String query, + String language, + int page) + +
      +          Search for collections by name.
      + TmdbResultsList<Company>searchCompanies(String companyName, + int page) + +
      +          Search Companies.
      + TmdbResultsList<Keyword>searchKeyword(String query, + int page) + +
      +          Search for keywords by name
      + TmdbResultsList<MovieList>searchList(String query, + String language, + int page) + +
      +          Search for lists by name and description.
      + TmdbResultsList<MovieDb>searchMovie(String movieName, + int searchYear, + String language, + boolean includeAdult, + int page) + +
      +          Search Movies This is a good starting point to start finding movies on TMDb.
      + TmdbResultsList<Person>searchPeople(String personName, + boolean includeAdult, + int page) + +
      +          This is a good starting point to start finding people on TMDb.
      + voidsetProxy(String host, + int port, + String username, + String password) + +
      +          Set the proxy information
      + voidsetTimeout(int connect, + int read) + +
      +          Set the connection and read time out values
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

      + -

        -
      • - - -

        Constructor Detail

        - - - - - - - -
          -
        • -

          TheMovieDbApi

          -
          public TheMovieDbApi(String apiKey,
-             org.yamj.api.common.http.CommonHttpClient httpClient)
-              throws MovieDbException
          -
          API for The Movie Db.
          -
          Parameters:
          apiKey -
          httpClient - The httpClient to use for web requests.
          -
          Throws:
          -
          MovieDbException
          -
          • -
        -
        • -
      + + + + + + +
      +Constructor Detail
      + +

      +TheMovieDbApi

      +
      +public TheMovieDbApi(String apiKey)
+              throws MovieDbException
      +
      +
      API for The Movie Db. +

      +

      +
      Parameters:
      apiKey - +
      Throws: +
      MovieDbException
      +
      +
      + +

      +TheMovieDbApi

      +
      +public TheMovieDbApi(String apiKey,
+                     org.yamj.api.common.http.CommonHttpClient httpClient)
+              throws MovieDbException
      +
      +
      API for The Movie Db. +

      +

      +
      Parameters:
      apiKey -
      httpClient - The httpClient to use for web requests. +
      Throws: +
      MovieDbException
      +
      + -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getApiKey

          -
          public String getApiKey()
          -
          Get the API key that is to be used
          -
          Returns:
          -
          • -
        - - - -
          -
        • -

          setProxy

          -
          public void setProxy(String host,
-            int port,
-            String username,
-            String password)
          -
          Set the proxy information
          -
          Parameters:
          host -
          port -
          username -
          password -
          -
          • -
        - - - -
          -
        • -

          setTimeout

          -
          public void setTimeout(int connect,
-              int read)
          -
          Set the connection and read time out values
          -
          Parameters:
          connect -
          read -
          -
          • -
        - - - -
          -
        • -

          compareMovies

          -
          public static boolean compareMovies(MovieDb moviedb,
-                    String title,
-                    String year)
          -
          Compare the MovieDB object with a title & year
          -
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare exact match
          -
          Returns:
          True if there is a match, False otherwise.
          -
          • -
        - - - -
          -
        • -

          compareMovies

          -
          public static boolean compareMovies(MovieDb moviedb,
-                    String title,
-                    String year,
-                    int maxDistance)
          -
          Compare the MovieDB object with a title & year
          -
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare
          maxDistance - The Levenshtein Distance between the two titles. 0 = exact match
          -
          Returns:
          True if there is a match, False otherwise.
          -
          • -
        - - - -
          -
        • -

          getConfiguration

          -
          public TmdbConfiguration getConfiguration()
          -
          Get the configuration information
          -
          Returns:
          -
          • -
        - - - -
          -
        • -

          createImageUrl

          -
          public URL createImageUrl(String imagePath,
-                 String requiredSize)
-                   throws MovieDbException
          -
          Generate the full image URL from the size and image path
          -
          Parameters:
          imagePath -
          requiredSize -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getAuthorisationToken

          -
          public TokenAuthorisation getAuthorisationToken()
-                                         throws MovieDbException
          -
          This method is used to generate a valid request token for user based authentication. + + + + + + +
          +Method Detail
          + +

          +getApiKey

          +
          +public String getApiKey()
          +
          +
          Get the API key that is to be used +

          +

          + +
          Returns:
          +
          +
          +
          + +

          +setProxy

          +
          +public void setProxy(String host,
+                     int port,
+                     String username,
+                     String password)
          +
          +
          Set the proxy information +

          +

          +
          Parameters:
          host -
          port -
          username -
          password -
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(int connect,
+                       int read)
          +
          +
          Set the connection and read time out values +

          +

          +
          Parameters:
          connect -
          read -
          +
          +
          +
          + +

          +compareMovies

          +
          +public static boolean compareMovies(MovieDb moviedb,
+                                    String title,
+                                    String year)
          +
          +
          Compare the MovieDB object with a title & year +

          +

          +
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare exact match +
          Returns:
          True if there is a match, False otherwise.
          +
          +
          +
          + +

          +compareMovies

          +
          +public static boolean compareMovies(MovieDb moviedb,
+                                    String title,
+                                    String year,
+                                    int maxDistance)
          +
          +
          Compare the MovieDB object with a title & year +

          +

          +
          Parameters:
          moviedb - The moviedb object to compare too
          title - The title of the movie to compare
          year - The year of the movie to compare
          maxDistance - The Levenshtein Distance between the two titles. 0 = exact match +
          Returns:
          True if there is a match, False otherwise.
          +
          +
          +
          + +

          +getConfiguration

          +
          +public TmdbConfiguration getConfiguration()
          +
          +
          Get the configuration information +

          +

          + +
          Returns:
          +
          +
          +
          + +

          +createImageUrl

          +
          +public URL createImageUrl(String imagePath,
+                          String requiredSize)
+                   throws MovieDbException
          +
          +
          Generate the full image URL from the size and image path +

          +

          +
          Parameters:
          imagePath -
          requiredSize - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getAuthorisationToken

          +
          +public TokenAuthorisation getAuthorisationToken()
+                                         throws MovieDbException
          +
          +
          This method is used to generate a valid request token for user based authentication. A request token is required in order to request a session id. You can generate any number of request tokens but they will expire after 60 minutes. - As soon as a valid session id has been created the token will be destroyed.
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getSessionToken

          -
          public TokenSession getSessionToken(TokenAuthorisation token)
-                             throws MovieDbException
          -
          This method is used to generate a session id for user based authentication. + As soon as a valid session id has been created the token will be destroyed. +

          +

          - A session id is required in order to use any of the write methods.
          -
          Parameters:
          token -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          getAccount

          -
          public Account getAccount(String sessionId)
-                   throws MovieDbException
          -
          Get the basic information for an account. You will need to have a valid session id.
          -
          Parameters:
          sessionId -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - - - - - -
          -
        • -

          removeFromWatchList

          -
          public StatusCode removeFromWatchList(String sessionId,
-                             int accountId,
-                             Integer movieId)
-                               throws MovieDbException
          -
          Remove a movie from an accounts watch list.
          -
          Parameters:
          sessionId -
          accountId -
          movieId -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieInfo

          -
          public MovieDb getMovieInfo(int movieId,
-                   String language,
-                   String... appendToResponse)
-                     throws MovieDbException
          -
          This method is used to retrieve all of the basic movie information. + If a guest session is not used for the first time within 24 hours, it will be automatically discarded. +

          +

          + +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getAccount

          +
          +public Account getAccount(String sessionId)
+                   throws MovieDbException
          +
          +
          Get the basic information for an account. You will need to have a valid session id. +

          +

          +
          Parameters:
          sessionId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getFavoriteMovies

          +
          +public List<MovieDb> getFavoriteMovies(String sessionId,
+                                       int accountId)
+                                throws MovieDbException
          +
          +
          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +changeFavoriteStatus

          +
          +public StatusCode changeFavoriteStatus(String sessionId,
+                                       int accountId,
+                                       Integer movieId,
+                                       boolean isFavorite)
+                                throws MovieDbException
          +
          +
          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +addToWatchList

          +
          +public StatusCode addToWatchList(String sessionId,
+                                 int accountId,
+                                 Integer movieId)
+                          throws MovieDbException
          +
          +
          Add a movie to an accounts watch list. +

          +

          +
          Parameters:
          sessionId -
          accountId -
          movieId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +removeFromWatchList

          +
          +public StatusCode removeFromWatchList(String sessionId,
+                                      int accountId,
+                                      Integer movieId)
+                               throws MovieDbException
          +
          +
          Remove a movie from an accounts watch list. +

          +

          +
          Parameters:
          sessionId -
          accountId -
          movieId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieInfo

          +
          +public MovieDb getMovieInfo(int movieId,
+                            String language,
+                            String... appendToResponse)
+                     throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. - MovieDbExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
          -
          Parameters:
          movieId -
          language -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieInfoImdb

          -
          public MovieDb getMovieInfoImdb(String imdbId,
-                       String language,
-                       String... appendToResponse)
-                         throws MovieDbException
          -
          This method is used to retrieve all of the basic movie information. + MovieDbExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. +

          +

          +
          Parameters:
          movieId -
          language -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getMovieInfoImdb

          +
          +public MovieDb getMovieInfoImdb(String imdbId,
+                                String language,
+                                String... appendToResponse)
+                         throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic movie information. It will return the single highest rated poster and backdrop. - MovieDbExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
          -
          Parameters:
          imdbId -
          language -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieAlternativeTitles

          -
          public TmdbResultsList<AlternativeTitle> getMovieAlternativeTitles(int movieId,
-                                                          String country,
-                                                          String... appendToResponse)
-                                                            throws MovieDbException
          -
          This method is used to retrieve all of the alternative titles we have for a particular movie.
          -
          Parameters:
          movieId -
          country -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieCasts

          -
          public TmdbResultsList<Person> getMovieCasts(int movieId,
-                                    String... appendToResponse)
-                                      throws MovieDbException
          -
          Get the cast information for a specific movie id. + MovieDbExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found. +

          +

          +
          Parameters:
          imdbId -
          language -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          - TODO: Add a function to enrich the data with the people methods
          -
          Parameters:
          movieId -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieImages

          -
          public TmdbResultsList<Artwork> getMovieImages(int movieId,
-                                      String language,
-                                      String... appendToResponse)
-                                        throws MovieDbException
          -
          This method should be used when you’re wanting to retrieve all of the images for a particular movie.
          -
          Parameters:
          movieId -
          language -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieKeywords

          -
          public TmdbResultsList<Keyword> getMovieKeywords(int movieId,
-                                        String... appendToResponse)
-                                          throws MovieDbException
          -
          This method is used to retrieve all of the keywords that have been added to a particular movie. +

          +getMovieAlternativeTitles

          +
          +public TmdbResultsList<AlternativeTitle> getMovieAlternativeTitles(int movieId,
+                                                                   String country,
+                                                                   String... appendToResponse)
+                                                            throws MovieDbException
          +
          +
          This method is used to retrieve all of the alternative titles we have for a particular movie. +

          +

          +
          Parameters:
          movieId -
          country -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          - Currently, only English keywords exist.
          -
          Parameters:
          movieId -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieReleaseInfo

          -
          public TmdbResultsList<ReleaseInfo> getMovieReleaseInfo(int movieId,
-                                               String language,
-                                               String... appendToResponse)
-                                                 throws MovieDbException
          -
          This method is used to retrieve all of the release and certification data we have for a specific movie.
          -
          Parameters:
          movieId -
          language -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieTrailers

          -
          public TmdbResultsList<Trailer> getMovieTrailers(int movieId,
-                                        String language,
-                                        String... appendToResponse)
-                                          throws MovieDbException
          -
          This method is used to retrieve all of the trailers for a particular movie. +

          +getMovieCasts

          +
          +public TmdbResultsList<Person> getMovieCasts(int movieId,
+                                             String... appendToResponse)
+                                      throws MovieDbException
          +
          +
          Get the cast information for a specific movie id. - Supported sites are YouTube and QuickTime.
          -
          Parameters:
          movieId -
          language -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getMovieTranslations

          -
          public TmdbResultsList<Translation> getMovieTranslations(int movieId,
-                                                String... appendToResponse)
-                                                  throws MovieDbException
          -
          This method is used to retrieve a list of the available translations for a specific movie.
          -
          Parameters:
          movieId -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getSimilarMovies

          -
          public TmdbResultsList<MovieDb> getSimilarMovies(int movieId,
-                                        String language,
-                                        int page,
-                                        String... appendToResponse)
-                                          throws MovieDbException
          -
          The similar movies method will let you retrieve the similar movies for a particular movie. + TODO: Add a function to enrich the data with the people methods +

          +

          +
          Parameters:
          movieId -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getMovieImages

          +
          +public TmdbResultsList<Artwork> getMovieImages(int movieId,
+                                               String language,
+                                               String... appendToResponse)
+                                        throws MovieDbException
          +
          +
          This method should be used when you’re wanting to retrieve all of the images for a particular movie. +

          +

          +
          Parameters:
          movieId -
          language -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieKeywords

          +
          +public TmdbResultsList<Keyword> getMovieKeywords(int movieId,
+                                                 String... appendToResponse)
+                                          throws MovieDbException
          +
          +
          This method is used to retrieve all of the keywords that have been added to a particular movie. + + Currently, only English keywords exist. +

          +

          +
          Parameters:
          movieId -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieReleaseInfo

          +
          +public TmdbResultsList<ReleaseInfo> getMovieReleaseInfo(int movieId,
+                                                        String language,
+                                                        String... appendToResponse)
+                                                 throws MovieDbException
          +
          +
          This method is used to retrieve all of the release and certification data we have for a specific movie. +

          +

          +
          Parameters:
          movieId -
          language -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieTrailers

          +
          +public TmdbResultsList<Trailer> getMovieTrailers(int movieId,
+                                                 String language,
+                                                 String... appendToResponse)
+                                          throws MovieDbException
          +
          +
          This method is used to retrieve all of the trailers for a particular movie. + + Supported sites are YouTube and QuickTime. +

          +

          +
          Parameters:
          movieId -
          language -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieTranslations

          +
          +public TmdbResultsList<Translation> getMovieTranslations(int movieId,
+                                                         String... appendToResponse)
+                                                  throws MovieDbException
          +
          +
          This method is used to retrieve a list of the available translations for a specific movie. +

          +

          +
          Parameters:
          movieId -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getSimilarMovies

          +
          +public TmdbResultsList<MovieDb> getSimilarMovies(int movieId,
+                                                 String language,
+                                                 int page,
+                                                 String... appendToResponse)
+                                          throws MovieDbException
          +
          +
          The similar movies method will let you retrieve the similar movies for a particular movie. This data is created dynamically but with the help of users votes on TMDb. - The data is much better with movies that have more keywords
          -
          Parameters:
          movieId -
          language -
          page -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - - - - - - - - - -
          -
        • -

          getUpcoming

          -
          public TmdbResultsList<MovieDb> getUpcoming(String language,
-                                   int page)
-                                     throws MovieDbException
          -
          Get the list of upcoming movies. + TODO: DOES NOT WORK AT THE MOMENT. This is due to the "value" item changing type in the ChangeItem +

          +

          +
          Parameters:
          movieId -
          startDate - the start date of the changes, optional
          endDate - the end date of the changes, optional +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getLatestMovie

          +
          +public MovieDb getLatestMovie()
+                       throws MovieDbException
          +
          +
          This method is used to retrieve the newest movie that was added to TMDb. +

          +

          + +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getUpcoming

          +
          +public TmdbResultsList<MovieDb> getUpcoming(String language,
+                                            int page)
+                                     throws MovieDbException
          +
          +
          Get the list of upcoming movies. This list refreshes every day. - The maximum number of items this list will include is 100.
          -
          Parameters:
          language -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getNowPlayingMovies

          -
          public TmdbResultsList<MovieDb> getNowPlayingMovies(String language,
-                                           int page)
-                                             throws MovieDbException
          -
          This method is used to retrieve the movies currently in theatres. + The maximum number of items this list will include is 100. +

          +

          +
          Parameters:
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getNowPlayingMovies

          +
          +public TmdbResultsList<MovieDb> getNowPlayingMovies(String language,
+                                                    int page)
+                                             throws MovieDbException
          +
          +
          This method is used to retrieve the movies currently in theatres. This is a curated list that will normally contain 100 movies. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPopularMovieList

          -
          public TmdbResultsList<MovieDb> getPopularMovieList(String language,
-                                           int page)
-                                             throws MovieDbException
          -
          This method is used to retrieve the daily movie popularity list. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getPopularMovieList

          +
          +public TmdbResultsList<MovieDb> getPopularMovieList(String language,
+                                                    int page)
+                                             throws MovieDbException
          +
          +
          This method is used to retrieve the daily movie popularity list. This list is updated daily. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getTopRatedMovies

          -
          public TmdbResultsList<MovieDb> getTopRatedMovies(String language,
-                                         int page)
-                                           throws MovieDbException
          -
          This method is used to retrieve the top rated movies that have over 10 votes on TMDb. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getTopRatedMovies

          +
          +public TmdbResultsList<MovieDb> getTopRatedMovies(String language,
+                                                  int page)
+                                           throws MovieDbException
          +
          +
          This method is used to retrieve the top rated movies that have over 10 votes on TMDb. The default response will return 20 movies. - TODO: Implement more than 20 movies
          -
          Parameters:
          language -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getRatedMovies

          -
          public List<MovieDb> getRatedMovies(String sessionId,
-                           int accountId)
-                             throws MovieDbException
          -
          Get the list of rated movies (and associated rating) for an account.
          -
          Parameters:
          sessionId -
          accountId -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          postMovieRating

          -
          public boolean postMovieRating(String sessionId,
-                      Integer movieId,
-                      Integer rating)
-                        throws MovieDbException
          -
          This method lets users rate a movie. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          - A valid session id is required.
          -
          Parameters:
          sessionId -
          movieId -
          rating -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getCollectionInfo

          -
          public CollectionInfo getCollectionInfo(int collectionId,
-                               String language)
-                                 throws MovieDbException
          -
          This method is used to retrieve all of the basic information about a movie collection. +

          +getRatedMovies

          +
          +public List<MovieDb> getRatedMovies(String sessionId,
+                                    int accountId)
+                             throws MovieDbException
          +
          +
          Get the list of rated movies (and associated rating) for an account. +

          +

          +
          Parameters:
          sessionId -
          accountId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          - You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection.
          -
          Parameters:
          collectionId -
          language -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          getPersonInfo

          -
          public Person getPersonInfo(int personId,
-                   String... appendToResponse)
-                     throws MovieDbException
          -
          This method is used to retrieve all of the basic person information. +

          +postMovieRating

          +
          +public boolean postMovieRating(String sessionId,
+                               Integer movieId,
+                               Integer rating)
+                        throws MovieDbException
          +
          +
          This method lets users rate a movie. - It will return the single highest rated profile image.
          -
          Parameters:
          personId -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonCredits

          -
          public TmdbResultsList<PersonCredit> getPersonCredits(int personId,
-                                             String... appendToResponse)
-                                               throws MovieDbException
          -
          This method is used to retrieve all of the cast & crew information for the person. + A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          movieId -
          rating - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          - It will return the single highest rated poster for each movie record.
          -
          Parameters:
          personId -
          appendToResponse -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          getPersonChanges

          -
          public void getPersonChanges(int personId,
-                    String startDate,
-                    String endDate)
-                      throws MovieDbException
          -
          Get the changes for a specific person id. +

          +getCollectionInfo

          +
          +public CollectionInfo getCollectionInfo(int collectionId,
+                                        String language)
+                                 throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic information about a movie collection. + + You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection. +

          +

          +
          Parameters:
          collectionId -
          language - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getCollectionImages

          +
          +public TmdbResultsList<Artwork> getCollectionImages(int collectionId,
+                                                    String language)
+                                             throws MovieDbException
          +
          +
          Get all of the images for a particular collection by collection id. +

          +

          +
          Parameters:
          collectionId -
          language - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonInfo

          +
          +public Person getPersonInfo(int personId,
+                            String... appendToResponse)
+                     throws MovieDbException
          +
          +
          This method is used to retrieve all of the basic person information. + + It will return the single highest rated profile image. +

          +

          +
          Parameters:
          personId -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonCredits

          +
          +public TmdbResultsList<PersonCredit> getPersonCredits(int personId,
+                                                      String... appendToResponse)
+                                               throws MovieDbException
          +
          +
          This method is used to retrieve all of the cast & crew information for the person. + + It will return the single highest rated poster for each movie record. +

          +

          +
          Parameters:
          personId -
          appendToResponse - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonImages

          +
          +public TmdbResultsList<Artwork> getPersonImages(int personId)
+                                         throws MovieDbException
          +
          +
          This method is used to retrieve all of the profile images for a person. +

          +

          +
          Parameters:
          personId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonChanges

          +
          +public void getPersonChanges(int personId,
+                             String startDate,
+                             String endDate)
+                      throws MovieDbException
          +
          +
          Get the changes for a specific person id. Changes are grouped by key, and ordered by date in descending order. @@ -1427,584 +1664,640 @@ extends Parameters:
          personId -
          startDate -
          endDate -
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getPersonPopular

          -
          public TmdbResultsList<Person> getPersonPopular()
-                                         throws MovieDbException
          -
          Get the list of popular people on The Movie Database. + The language is present on fields that are translatable. +

          +

          +
          Parameters:
          personId -
          startDate -
          endDate - +
          Throws: +
          MovieDbException
          +
          + +
          - This list refreshes every day.
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - -
          -
        • -

          getCompanyInfo

          -
          public Company getCompanyInfo(int companyId)
-                       throws MovieDbException
          -
          This method is used to retrieve the basic information about a production company on TMDb.
          -
          Parameters:
          companyId -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getCompanyMovies

          -
          public TmdbResultsList<MovieDb> getCompanyMovies(int companyId,
-                                        String language,
-                                        int page)
-                                          throws MovieDbException
          -
          This method is used to retrieve the movies associated with a company. + This list refreshes every day. +

          +

          + +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getPersonPopular

          +
          +public TmdbResultsList<Person> getPersonPopular(int page)
+                                         throws MovieDbException
          +
          +
          Get the list of popular people on The Movie Database. + + This list refreshes every day. +

          +

          +
          Parameters:
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getPersonLatest

          +
          +public Person getPersonLatest()
+                       throws MovieDbException
          +
          +
          Get the latest person id. +

          +

          + +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getCompanyInfo

          +
          +public Company getCompanyInfo(int companyId)
+                       throws MovieDbException
          +
          +
          This method is used to retrieve the basic information about a production company on TMDb. +

          +

          +
          Parameters:
          companyId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getCompanyMovies

          +
          +public TmdbResultsList<MovieDb> getCompanyMovies(int companyId,
+                                                 String language,
+                                                 int page)
+                                          throws MovieDbException
          +
          +
          This method is used to retrieve the movies associated with a company. These movies are returned in order of most recently released to oldest. The default response will return 20 movies per page. - TODO: Implement more than 20 movies
          -
          Parameters:
          companyId -
          language -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getGenreList

          -
          public TmdbResultsList<Genre> getGenreList(String language)
-                                    throws MovieDbException
          -
          You can use this method to retrieve the list of genres used on TMDb. + TODO: Implement more than 20 movies +

          +

          +
          Parameters:
          companyId -
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          - These IDs will correspond to those found in movie calls.
          -
          Parameters:
          language -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getGenreMovies

          -
          public TmdbResultsList<MovieDb> getGenreMovies(int genreId,
-                                      String language,
-                                      int page,
-                                      boolean includeAllMovies)
-                                        throws MovieDbException
          -
          Get a list of movies per genre. +

          +getGenreList

          +
          +public TmdbResultsList<Genre> getGenreList(String language)
+                                    throws MovieDbException
          +
          +
          You can use this method to retrieve the list of genres used on TMDb. + + These IDs will correspond to those found in movie calls. +

          +

          +
          Parameters:
          language - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getGenreMovies

          +
          +public TmdbResultsList<MovieDb> getGenreMovies(int genreId,
+                                               String language,
+                                               int page,
+                                               boolean includeAllMovies)
+                                        throws MovieDbException
          +
          +
          Get a list of movies per genre. It is important to understand that only movies with more than 10 votes get listed. - This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages.
          -
          Parameters:
          genreId -
          language -
          page -
          includeAllMovies -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          searchMovie

          -
          public TmdbResultsList<MovieDb> searchMovie(String movieName,
-                                   int searchYear,
-                                   String language,
-                                   boolean includeAdult,
-                                   int page)
-                                     throws MovieDbException
          -
          Search Movies This is a good starting point to start finding movies on TMDb.
          -
          Parameters:
          movieName -
          searchYear - Limit the search to the provided year. Zero (0) will get all years
          language - The language to include. Can be blank/null.
          includeAdult - true or false to include adult titles in the search
          page - The page of results to return. 0 to get the default (first page)
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          searchPeople

          -
          public TmdbResultsList<Person> searchPeople(String personName,
-                                   boolean includeAdult,
-                                   int page)
-                                     throws MovieDbException
          -
          This is a good starting point to start finding people on TMDb. + This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages. +

          +

          +
          Parameters:
          genreId -
          language -
          page -
          includeAllMovies - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          - The idea is to be a quick and light method so you can iterate through people quickly.
          -
          Parameters:
          personName -
          includeAdult -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - -
          -
        • -

          searchCompanies

          -
          public TmdbResultsList<Company> searchCompanies(String companyName,
-                                       int page)
-                                         throws MovieDbException
          -
          Search Companies. +

          +searchMovie

          +
          +public TmdbResultsList<MovieDb> searchMovie(String movieName,
+                                            int searchYear,
+                                            String language,
+                                            boolean includeAdult,
+                                            int page)
+                                     throws MovieDbException
          +
          +
          Search Movies This is a good starting point to start finding movies on TMDb. +

          +

          +
          Parameters:
          movieName -
          searchYear - Limit the search to the provided year. Zero (0) will get all years
          language - The language to include. Can be blank/null.
          includeAdult - true or false to include adult titles in the search
          page - The page of results to return. 0 to get the default (first page) +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchCollection

          +
          +public TmdbResultsList<Collection> searchCollection(String query,
+                                                    String language,
+                                                    int page)
+                                             throws MovieDbException
          +
          +
          Search for collections by name. +

          +

          +
          Parameters:
          query -
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchPeople

          +
          +public TmdbResultsList<Person> searchPeople(String personName,
+                                            boolean includeAdult,
+                                            int page)
+                                     throws MovieDbException
          +
          +
          This is a good starting point to start finding people on TMDb. + + The idea is to be a quick and light method so you can iterate through people quickly. +

          +

          +
          Parameters:
          personName -
          includeAdult -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchList

          +
          +public TmdbResultsList<MovieList> searchList(String query,
+                                             String language,
+                                             int page)
+                                      throws MovieDbException
          +
          +
          Search for lists by name and description. +

          +

          +
          Parameters:
          query -
          language -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +searchCompanies

          +
          +public TmdbResultsList<Company> searchCompanies(String companyName,
+                                                int page)
+                                         throws MovieDbException
          +
          +
          Search Companies. You can use this method to search for production companies that are part of TMDb. The company IDs will map to those returned on movie calls. - http://help.themoviedb.org/kb/api/search-companies
          -
          Parameters:
          companyName -
          page -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - - - - - -
          -
        • -

          createList

          -
          public String createList(String sessionId,
-                String name,
-                String description)
-                  throws MovieDbException
          -
          This method lets users create a new list. A valid session id is required.
          -
          Parameters:
          sessionId -
          name -
          description -
          -
          Returns:
          The list id
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          isMovieOnList

          -
          public boolean isMovieOnList(String listId,
-                    Integer movieId)
-                      throws MovieDbException
          -
          Check to see if a movie ID is already added to a list.
          -
          Parameters:
          listId -
          movieId -
          -
          Returns:
          true if the movie is on the list
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          addMovieToList

          -
          public StatusCode addMovieToList(String sessionId,
-                        String listId,
-                        Integer movieId)
-                          throws MovieDbException
          -
          This method lets users add new movies to a list that they created. A valid session id is required.
          -
          Parameters:
          sessionId -
          listId -
          movieId -
          -
          Returns:
          true if the movie is on the list
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          removeMovieFromList

          -
          public StatusCode removeMovieFromList(String sessionId,
-                             String listId,
-                             Integer movieId)
-                               throws MovieDbException
          -
          This method lets users remove movies from a list that they created. A valid session id is required.
          -
          Parameters:
          sessionId -
          listId -
          movieId -
          -
          Returns:
          true if the movie is on the list
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getWatchList

          -
          public List<MovieDb> getWatchList(String sessionId,
-                         int accountId)
-                           throws MovieDbException
          -
          Get the list of movies on an accounts watchlist.
          -
          Parameters:
          sessionId -
          accountId -
          -
          Returns:
          The watchlist of the user
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          deleteMovieList

          -
          public StatusCode deleteMovieList(String sessionId,
-                         String listId)
-                           throws MovieDbException
          -
          This method lets users delete a list that they created. A valid session id is required.
          -
          Parameters:
          sessionId -
          listId -
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - -
          -
        • -

          getMovieChangesList

          -
          public TmdbResultsList<ChangedMovie> getMovieChangesList(int page,
-                                                String startDate,
-                                                String endDate)
-                                                  throws MovieDbException
          -
          Get a list of movie ids that have been edited. By default we show the last 24 hours and only 100 items per page. The maximum + http://help.themoviedb.org/kb/api/search-companies +

          +

          +
          Parameters:
          companyName -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +searchKeyword

          +
          +public TmdbResultsList<Keyword> searchKeyword(String query,
+                                              int page)
+                                       throws MovieDbException
          +
          +
          Search for keywords by name +

          +

          +
          Parameters:
          query -
          page - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getList

          +
          +public MovieDbList getList(String listId)
+                    throws MovieDbException
          +
          +
          Get a list by its ID +

          +

          +
          Parameters:
          listId - +
          Returns:
          The list and its items +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getUserLists

          +
          +public List<MovieDbList> getUserLists(String sessionId,
+                                      int accountID)
+                               throws MovieDbException
          +
          +
          Get all lists of a given user +

          +

          +
          Parameters:
          sessionId -
          accountID - +
          Returns:
          The lists +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +createList

          +
          +public String createList(String sessionId,
+                         String name,
+                         String description)
+                  throws MovieDbException
          +
          +
          This method lets users create a new list. A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          name -
          description - +
          Returns:
          The list id +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +isMovieOnList

          +
          +public boolean isMovieOnList(String listId,
+                             Integer movieId)
+                      throws MovieDbException
          +
          +
          Check to see if a movie ID is already added to a list. +

          +

          +
          Parameters:
          listId -
          movieId - +
          Returns:
          true if the movie is on the list +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +addMovieToList

          +
          +public StatusCode addMovieToList(String sessionId,
+                                 String listId,
+                                 Integer movieId)
+                          throws MovieDbException
          +
          +
          This method lets users add new movies to a list that they created. A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          listId -
          movieId - +
          Returns:
          true if the movie is on the list +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +removeMovieFromList

          +
          +public StatusCode removeMovieFromList(String sessionId,
+                                      String listId,
+                                      Integer movieId)
+                               throws MovieDbException
          +
          +
          This method lets users remove movies from a list that they created. A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          listId -
          movieId - +
          Returns:
          true if the movie is on the list +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getWatchList

          +
          +public List<MovieDb> getWatchList(String sessionId,
+                                  int accountId)
+                           throws MovieDbException
          +
          +
          Get the list of movies on an accounts watchlist. +

          +

          +
          Parameters:
          sessionId -
          accountId - +
          Returns:
          The watchlist of the user +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +deleteMovieList

          +
          +public StatusCode deleteMovieList(String sessionId,
+                                  String listId)
+                           throws MovieDbException
          +
          +
          This method lets users delete a list that they created. A valid session id is required. +

          +

          +
          Parameters:
          sessionId -
          listId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getKeyword

          +
          +public Keyword getKeyword(String keywordId)
+                   throws MovieDbException
          +
          +
          Get the basic information for a specific keyword id. +

          +

          +
          Parameters:
          keywordId - +
          Returns:
          +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getKeywordMovies

          +
          +public TmdbResultsList<KeywordMovie> getKeywordMovies(String keywordId,
+                                                      String language,
+                                                      int page)
+                                               throws MovieDbException
          +
          +
          Get the list of movies for a particular keyword by id. +

          +

          +
          Parameters:
          keywordId -
          language -
          page - +
          Returns:
          List of movies with the keyword +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getMovieChangesList

          +
          +public TmdbResultsList<ChangedMovie> getMovieChangesList(int page,
+                                                         String startDate,
+                                                         String endDate)
+                                                  throws MovieDbException
          +
          +
          Get a list of movie ids that have been edited. By default we show the last 24 hours and only 100 items per page. The maximum number of days that can be returned in a single request is 14. You can then use the movie changes API to get the actual data that has been changed. Please note that the change log system to support this was changed on October 5, 2012 and will only - show movies that have been edited since.
          -
          Parameters:
          page -
          startDate - the start date of the changes, optional
          endDate - the end date of the changes, optional
          -
          Returns:
          List of changed movie
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - - - - - - - - -
          -
        • -

          getDiscover

          -
          public TmdbResultsList<MovieDb> getDiscover(int page,
-                                   String language,
-                                   String sortBy,
-                                   boolean includeAdult,
-                                   int year,
-                                   int primaryReleaseYear,
-                                   int voteCountGte,
-                                   float voteAverageGte,
-                                   String withGenres,
-                                   String releaseDateGte,
-                                   String releaseDateLte,
-                                   String certificationCountry,
-                                   String certificationLte,
-                                   String withCompanies)
-                                     throws MovieDbException
          -
          Discover movies by different types of data like average rating, number of votes, genres and certifications. + show movies that have been edited since. +

          +

          +
          Parameters:
          page -
          startDate - the start date of the changes, optional
          endDate - the end date of the changes, optional +
          Returns:
          List of changed movie +
          Throws: +
          MovieDbException
          +
          + +
          + +

          +getPersonChangesList

          +
          +public void getPersonChangesList(int page,
+                                 String startDate,
+                                 String endDate)
+                          throws MovieDbException
          +
          +
          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getJobs

          +
          +public TmdbResultsList<JobDepartment> getJobs()
+                                       throws MovieDbException
          +
          +
          + +
          Throws: +
          MovieDbException
          +
          +
          +
          + +

          +getDiscover

          +
          +public TmdbResultsList<MovieDb> getDiscover(int page,
+                                            String language,
+                                            String sortBy,
+                                            boolean includeAdult,
+                                            int year,
+                                            int primaryReleaseYear,
+                                            int voteCountGte,
+                                            float voteAverageGte,
+                                            String withGenres,
+                                            String releaseDateGte,
+                                            String releaseDateLte,
+                                            String certificationCountry,
+                                            String certificationLte,
+                                            String withCompanies)
+                                     throws MovieDbException
          +
          +
          Discover movies by different types of data like average rating, number of votes, genres and certifications. You can alternatively create a "discover" object and pass it to this method to cut out the requirement for all of these - parameters
          -
          Parameters:
          page - Minimum value is 1
          language - ISO 639-1 code.
          sortBy - Available options are vote_average.desc, vote_average.asc, release_date.desc, release_date.asc, - popularity.desc, popularity.asc
          includeAdult - Toggle the inclusion of adult titles
          year - Filter the results release dates to matches that include this value
          primaryReleaseYear - Filter the results so that only the primary release date year has this value
          voteCountGte - Only include movies that are equal to, or have a vote count higher than this value
          voteAverageGte - Only include movies that are equal to, or have a higher average rating than this value
          withGenres - Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple - values can be specified. Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
          releaseDateGte - The minimum release to include. Expected format is YYYY-MM-DD
          releaseDateLte - The maximum release to include. Expected format is YYYY-MM-DD
          certificationCountry - Only include movies with certifications for a specific country. When this value is specified, - 'certificationLte' is required. A ISO 3166-1 is expected.
          certificationLte - Only include movies with this certification and lower. Expected value is a valid certification for - the specified 'certificationCountry'.
          withCompanies - Filter movies to include a specific company. Expected value is an integer (the id of a company). They - can be comma separated to indicate an 'AND' query.
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - -
          -
        • -

          getDiscover

          -
          public TmdbResultsList<MovieDb> getDiscover(Discover discover)
-                                     throws MovieDbException
          -
          Discover movies by different types of data like average rating, number of votes, genres and certifications.
          -
          Parameters:
          discover - A discover object containing the search criteria required
          -
          Returns:
          -
          Throws:
          -
          MovieDbException
          -
          • -
        - - - - -
        • -
      -
      • -
    -
-
+ parameters +

+

+
Parameters:
page - Minimum value is 1
language - ISO 639-1 code.
sortBy - Available options are vote_average.desc, vote_average.asc, release_date.desc, release_date.asc, + popularity.desc, popularity.asc
includeAdult - Toggle the inclusion of adult titles
year - Filter the results release dates to matches that include this value
primaryReleaseYear - Filter the results so that only the primary release date year has this value
voteCountGte - Only include movies that are equal to, or have a vote count higher than this value
voteAverageGte - Only include movies that are equal to, or have a higher average rating than this value
withGenres - Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple + values can be specified. Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
releaseDateGte - The minimum release to include. Expected format is YYYY-MM-DD
releaseDateLte - The maximum release to include. Expected format is YYYY-MM-DD
certificationCountry - Only include movies with certifications for a specific country. When this value is specified, + 'certificationLte' is required. A ISO 3166-1 is expected.
certificationLte - Only include movies with this certification and lower. Expected value is a valid certification for + the specified 'certificationCountry'.
withCompanies - Filter movies to include a specific company. Expected value is an integer (the id of a company). They + can be comma separated to indicate an 'AND' query. +
Returns:
+
Throws: +
MovieDbException
+
+ +
+ +

+getDiscover

+
+public TmdbResultsList<MovieDb> getDiscover(Discover discover)
+                                     throws MovieDbException
+
+
Discover movies by different types of data like average rating, number of votes, genres and certifications. +

+

+
Parameters:
discover - A discover object containing the search criteria required +
Returns:
+
Throws: +
MovieDbException
+
+
+
+ +

+convertToJson

+
+public static String convertToJson(Map<String,?> map)
+                            throws MovieDbException
+
+
Use Jackson to convert Map to JSON string. +

+

+
Parameters:
map - +
Returns:
+
Throws: +
MovieDbException
+
+
+
+ + -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
+ + + + + + + + + SUMMARY: NESTED | FIELD | CONSTR | METHOD + +DETAIL: FIELD | CONSTR | METHOD + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html index 6ed438ccc..968cc0323 100644 --- a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html +++ b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.MovieDbExceptionType.html @@ -1,187 +1,221 @@ - - - - - -Uses of Class com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType (API-The MovieDB 3.9 API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -
-

Uses of Class
com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType

-
-
- -
+ +
+
+

+Uses of Class
com.omertron.themoviedbapi.MovieDbException.MovieDbExceptionType

+
+ + + + + + + + + +
+Packages that use MovieDbException.MovieDbExceptionType
com.omertron.themoviedbapi  
+  +

+ + + + + +
+Uses of MovieDbException.MovieDbExceptionType in com.omertron.themoviedbapi
+  +

+ + + + + + + + + + + + + + + + + +
Methods in com.omertron.themoviedbapi that return MovieDbException.MovieDbExceptionType
+ MovieDbException.MovieDbExceptionTypeMovieDbException.getExceptionType() + +
+           
+static MovieDbException.MovieDbExceptionTypeMovieDbException.MovieDbExceptionType.valueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static MovieDbException.MovieDbExceptionType[]MovieDbException.MovieDbExceptionType.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + +
Constructors in com.omertron.themoviedbapi with parameters of type MovieDbException.MovieDbExceptionType
MovieDbException(MovieDbException.MovieDbExceptionType exceptionType, + String response) + +
+           
MovieDbException(MovieDbException.MovieDbExceptionType exceptionType, + String response, + Throwable cause) + +
+           
+  +

+

+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -

Copyright © 2012-2013. All Rights Reserved.

- - + +
+Copyright © 2012-2013. All Rights Reserved. + + diff --git a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html index e9db634b8..faa9a5f06 100644 --- a/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html +++ b/apidocs/com/omertron/themoviedbapi/class-use/MovieDbException.html @@ -1,681 +1,864 @@ - - - - - -Uses of Class com.omertron.themoviedbapi.MovieDbException (API-The MovieDB 3.9 API) - - - - - - +} + + + + + + +
+ + -
- - - - - -
-
- - - -
- -
- - -
+ + + + + + + + -
-

Uses of Class
com.omertron.themoviedbapi.MovieDbException

-
-
-